@averay/codeformat 0.1.9 → 0.1.11

package/.prettierrc.json

@@ -1,5 +1,7 @@
 {
-  "$schema": "http://json.schemastore.org/prettierrc",
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "arrowParens": "always",
+  "proseWrap": "never",
   "semi": true,
   "singleQuote": true,
   "trailingComma": "all"

package/README.md

@@ -12,16 +12,36 @@ A very opinionated collection of configurations for a number of code formatting
    ln -s node_modules/@averay/codeformat/.editorconfig node_modules/@averay/codeformat/.prettierrc.json ./
    ```
 
-3. Generate the ESLint configuration after any custom ignore definitions:
-
-   ```js
-   // eslint.config.js
-   import { makeEslintConfig } from '@averay/codeformat';
-
-   export default [
-     {
-       ignores: ['dist/**/*'],
-     },
-     ...makeEslintConfig({ tsconfigPath: './tsconfig.json' }),
-   ];
-   ```
+3. Import and call the relevant configuration builders for specific tools
+
+4. Lint the codebase with `npx codeformat check`, or apply automatic fixes with `npx codeformat fix`
+
+### ESLint
+
+Create an `eslint.config.js` file and create the configuration:
+
+```js
+// eslint.config.js
+import { makeEslintConfig } from '@averay/codeformat';
+
+export default [
+  {
+    ignores: ['dist/**/*'],
+  },
+  ...makeEslintConfig({ tsconfigPath: './tsconfig.json' }),
+  // Custom overrides can be added here
+];
+```
+
+### Stylelint
+
+Create a `stylelint.config.cjs` file and create the configuration:
+
+```js
+// stylelint.config.cjs
+const { makeStylelintConfig } = require('@averay/codeformat');
+
+module.exports = makeStylelintConfig();
+```
+
+_(Stylelint does not currently support ESM so a `.cjs` file with CommonJS import & export syntax must be used)_

package/bin-codeformat.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+set -e
+
+# Parse arguments
+ACTION="$1"
+DIR="$2"
+if [ "$DIR" = '' ]; then
+  DIR='.'
+fi
+
+CONFIG_PATH_TYPESCRIPT="$DIR/tsconfig.json"
+
+if [ "$ACTION" = 'check' ]; then
+  npx eslint "$DIR"
+  npx prettier --check "$DIR"
+  if [ -f "$CONFIG_PATH_TYPESCRIPT" ]; then
+    npx tsc --noEmit "$DIR/tsconfig.json"
+  fi
+  npx stylelint --allow-empty-input "$DIR/**/*.{css,sass,scss}"
+elif [ "$ACTION" = 'fix' ]; then
+  npx eslint --fix "$DIR"
+  npx prettier --write "$DIR"
+  npx stylelint --fix --allow-empty-input "$DIR/**/*.{css,sass,scss}"
+else
+  # Invalid/unset arguments
+  echo "Usage:
+  $0 check [root-path]
+  $0 fix [root-path]" >&2
+  exit 1
+fi