ggstyle

Greater Goods Style Guide

Usage no npm install needed!

<script type="module">
  import ggstyle from 'https://cdn.skypack.dev/ggstyle';
</script>

README

Greater Goods Style Guide


This is a fork of Happiness, which in turn is a fork of Standard.

Usage

Install globally:

$ npm install ggstyle -g

After you've done that you should be able to use the ggstyle program. The simplest use case would be checking the style of all TypeScript or JavaScript files in the current working directory:

$ ggstyle
Error: Use Greater Goods Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.

You can optionally pass in a directory (or directories) using the glob pattern. Be sure to quote paths containing glob patterns so that they are expanded by standard instead of your shell:

$ ggstyle "src/util/**/*.js" "test/**/*.js"

To disable the linter on a certain file or line, or disable a specific rule, refer to this guide

Making Changes

Clone down the project and install packages:

$ git clone https://github.com/dmdbrands/gg_styleGuide
$ cd gg_styleGuide
$ npm install

Make changes and commit, then update the version and publish:

$ npm adduser
Username: <dev_gg>
Password: < >
Email: (this IS public) <dev@greatergoods.com>
Logged in as dev_gg on https://registry.npmjs.org/.
$ npm version <patch> <minor> <major>
$ npm publish

Some changes may require you to alter gg-standard-engine instead, such as what file types the linter checks.