0.2.5 • Published 2 years ago
@geekhive/gh-cli v0.2.5
gh-cli
A tool for easily installing front end language lint and formatting standards to projects.
Commands
Command | Description |
---|---|
standards [keywords...] | Add standards for given standard keywords |
Standards
Standard | Keyword | Standard | Lint Tool | Formatting Tool |
---|---|---|---|---|
JavaScript-only | javascript | @geekhive/eslint-config-standard | ESlint | Prettier |
Script | script | @geekhive/tslint-config-standard | ESlint | Prettier |
Style | style | @geekhive/stylelint-config-standard | stylelint | Prettier |
Usage
Run with npx
:
# Run the CLI tool and install all standards
npx @geekhive/gh-cli standards script style
Install the CLI tool globally and use:
# Install globally with npm
npm install -g @geekhive/gh-cli
# Install globally with yarn
yarn add -g @geekhive/gh-cli
# Run the CLI tool and install all standards
@geekhive/gh-cli standards script style
Visual Studio Code Plugins
Formatting
code --install-extension EditorConfig.EditorConfig
code --install-extension esbenp.prettier-vscode
Scripts
code --install-extension dbaeumer.vscode-eslint
code --install-extension esbenp.prettier-vscode
code --install-extension mikestead.dotenv
code --install-extension ms-vscode.vscode-typescript-tslint-plugin
Styles
code --install-extension stylelint.vscode-stylelint
Tools
code --install-extension donjayamanne.githistory
code --install-extension eamodio.gitlens
code --install-extension ms-vsliveshare.vsliveshare
code --install-extension msjsdiag.debugger-for-chrome
code --install-extension ritwickdey.LiveServer
code --install-extension yzane.markdown-pdf
Development
Make sure to commit the build files as this allows running npx directly against a branch.
Run the watch task:
yarn run dev
Run a build:
yarn run build
Execute the CLI tool:
node dist/gh.js standards js ts scss
Debug the CLI tool:
node --inspect-brk dist/gh.js standards js ts scss