create-styled-components

README

日本語ドキュメント

see document/Create Styled Components for Vscode.pptx

Features

This extension is partially copied from github project below and changed templates for our project.
brendon1555/vscode-react-component-generator

It can create template components with typescript, jest test and storybook.

About Template.

Our template will use the libraries below.
@testing-library/react
jest
typescript
@chakra-ui
react-i18next(for localize)

Install

From vsix file

  1. Download vsix file from dist folder.
    create-styled-components-0.0.1.vsix.
  2. Click extension icon in VSCode.
  3. Click the ... in top-right conner of the extension window.
  4. Click the Install from VSIX in the submenu.
  5. Select you downloaded vsix file and install it.

Usage

From Explorer

  • Right click the folder in the sidebar where you want to create a component.
  • Select Create Styled Component.
  • Select Typescript(it is only select) and whether to include Storybook or Tests.
  • Enter a name for the Component.
  • A Component will be created in a directory named after your input.

From Command Palette

  • Open the command palette and type Create Styled Component, press Enter.
  • Select Typescript(it is only select) and whether to include Storybook or Tests.
  • Enter a name for the Component.
  • A Component will be created in a directory named after your input.

Configuration

You can access to the extension's settings through VSCode settings. You can customize:

reactComponentGenerator.componentsPath (default: "")

Path relative to the workspace root to place components when not using the Explorer.

Known Issues

Only use Typescript.

Release Notes

0.0.1

It is for our project.


Following extension guidelines

see here

generate installer file command

npm install -g vsce

vsce package

more