Merge pull request #68 from shiftcode/#67-format-everything

#67 format everything

Author: mumenthalers

.commitlintrc.yml

@@ -1,4 +1,4 @@
 extends:
-  - "@commitlint/config-angular"
+  - '@commitlint/config-angular'
 rules:
   'header-max-length': [2, 'always', 100]

.github/workflows/copilot-setup-steps.yml

@@ -1,6 +1,6 @@
 # https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment
 # The copilot-setup-steps.yml workflow won't trigger unless it's present on your main branch.
-name: "Copilot Setup Steps"
+name: 'Copilot Setup Steps'
 
 # Automatically run the setup steps when they are changed to allow for easy validation, and
 # allow manual testing through the repository's "Actions" tab
@@ -33,4 +33,4 @@ jobs:
           cache: 'npm'
 
       - name: GitHub registry Auth & Install Dependencies
-        run: npm ci
+        run: npm ci

.github/workflows/main.yml

@@ -32,7 +32,7 @@ jobs:
         name: Check for execution
         uses: shiftcode/[email protected]
         with:
-          skipOnCommitMsg: "[skip_build]"
+          skipOnCommitMsg: '[skip_build]'
           githubToken: ${{ secrets.GITHUB_TOKEN }}
   test:
     runs-on: ubuntu-latest

.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged && npx lerna exec --concurrency 1 --stream lint-staged
+npx lerna exec --concurrency 1 --stream lint-staged && npx lint-staged

.lintstagedrc.yml

@@ -1,2 +1,5 @@
 ./package.json:
   - npx sort-package-json
+
+'*':
+  - npm run format:staged

.prettierignore

@@ -0,0 +1 @@
+dist/

README.md

@@ -2,35 +2,37 @@
 
 Public helper packages with commonly used utilities / helpers.
 
+> [![@shiftcode/branch-utilities](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Fbranch-utilities%2Fpackage.json&label=%40shiftcode%2Fbranch-utilities)](packages/branch-utilities) \
+> functions to read information about the current branch either locally or inside Github actions.
 
->[![@shiftcode/branch-utilities](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Fbranch-utilities%2Fpackage.json&label=%40shiftcode%2Fbranch-utilities)](packages/branch-utilities) \
->functions to read information about the current branch either locally or inside Github actions.
+> [![@shiftcode/eslint-config-recommended](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Feslint-config-recommended%2Fpackage.json&label=%40shiftcode%2Feslint-config-recommended)](packages/eslint-config-recommended) \
+> Our recommended config for eslint. We provide two versions, one for usage in node projects and one for Angular.
 
->[![@shiftcode/eslint-config-recommended](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Feslint-config-recommended%2Fpackage.json&label=%40shiftcode%2Feslint-config-recommended)](packages/eslint-config-recommended) \
->Our recommended config for eslint. We provide two versions, one for usage in node projects and one for Angular.
+> [![@shiftcode/eslint-plugin-rules](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Feslint-plugin-rules%2Fpackage.json&label=%40shiftcode%2Feslint-plugin-rules)](packages/eslint-plugin-rules) \
+> Contains some custom es lint rules. Those are used in our recommended eslint config.
 
->[![@shiftcode/eslint-plugin-rules](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Feslint-plugin-rules%2Fpackage.json&label=%40shiftcode%2Feslint-plugin-rules)](packages/eslint-plugin-rules) \
->Contains some custom es lint rules. Those are used in our recommended eslint config.
- 
->[![@shiftcode/publish-helper](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Fpublish-helper%2Fpackage.json&label=%40shiftcode%2Fpublish-helper)](packages/publish-helper)\
->scripts to prepare and publish libs inside mono-repos with lerna
+> [![@shiftcode/publish-helper](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Fpublish-helper%2Fpackage.json&label=%40shiftcode%2Fpublish-helper)](packages/publish-helper)\
+> scripts to prepare and publish libs inside mono-repos with lerna
 
->[![@shiftcode/utilities](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Futilities%2Fpackage.json&label=%40shiftcode%2Futilities)](packages/utilities)\
->various utility functions, constants and helper types - usable in Node and Browsers
+> [![@shiftcode/utilities](https://img.shields.io/github/package-json/v/shiftcode/sc-commons-public?filename=packages%2Futilities%2Fpackage.json&label=%40shiftcode%2Futilities)](packages/utilities)\
+> various utility functions, constants and helper types - usable in Node and Browsers
 
 ## Usage
+
 Add a `.npmrc` file to the root of your project:
+
 ```
 @shiftcode:registry=https://npm.pkg.github.com
 ```
 
 ## Quick Start
-* `npm i`
-* `npm run build`
-* start developing
 
+- `npm i`
+- `npm run build`
+- start developing
 
 ## Versioning
+
 When opening a PR lerna publishes a new prerelease version with the preId `-prXX.{COUNT}`.
 By creating this version lerna creates a commit with the updated versions in the package.json. It does not update the `peerDependencies` versions.
 
@@ -39,26 +41,31 @@ After merging the PR back to the master a new release is published with the grad
 > ensure your branch is named correctly by the convention `#XX-name` where `XX` is your github issue number.
 
 ### Hint
+
 If it happens that you already have another commit locally, before updating the branch with this `build(release):..` commit:
-> use `rebase` instead of `merge`
 
+> use `rebase` instead of `merge`
 
 ## Anatomy of the repo
 
 We use lerna to manage the packages.
+
 - For lerna to know the topological order of packages, we define the dependencies between the packages in each individual package as `devDependency`
 - For testing reasons we compile against the source code to run tests without prior compiling of the source, this requires `tsconfig.paths` definitions and also `moduleNameMapper` in `jest.config.js`
 
 ## ES Version
+
 We support two runtimes: `node` and `latest browser versions`.
 
 ### Node 22
-Node 22 (which is also supported by AWS Lambda) supports [97%](https://node.green/#ES2022) of `es2022` features 
+
+Node 22 (which is also supported by AWS Lambda) supports [97%](https://node.green/#ES2022) of `es2022` features
 (no version supports 100%) and [100%](https://node.green/#ES2023) of `es2023` features.
 The only `es2022` feature that is currently not supported and needs a polyfill when using it is
-[RegExp Match Indices (shows up in flags)](https://node.green/#ES2022-features-RegExp-Match-Indices---hasIndices-----d--flag-) (see [2ality blog](https://2ality.com/2019/12/regexp-match-indices.html) for insights). 
+[RegExp Match Indices (shows up in flags)](https://node.green/#ES2022-features-RegExp-Match-Indices---hasIndices-----d--flag-) (see [2ality blog](https://2ality.com/2019/12/regexp-match-indices.html) for insights).
 Polyfill can be found here: https://www.npmjs.com/package/regexp-match-indices.
 
 ### Browser
+
 For modern browsers the latest fully supported version is `es2023` (see [can-i-use](https://caniuse.com/?search=es2023))
 which therefore is the target for `@shiftcode/utilities` package (see [package README](./packages/utilities/README.md)).

package-lock.json

@@ -11,8 +11,9 @@
   "scripts": {
     "build:ci": "lerna run build",
     "build:lint:ci": "lerna run build --scope @shiftcode/eslint-plugin-rules && lerna run build --scope @shiftcode/eslint-config-recommended",
-    "format": "lerna run format",
-    "format:ci": "lerna run format:ci",
+    "format": "prettier --write .",
+    "format:ci": "prettier --check .",
+    "format:staged": "prettier --write --ignore-unknown",
     "lint:ci": "lerna run lint:ci",
     "prepare": "husky",
     "publish-libs": "node packages/publish-helper/dist/publish-lib",

package.json

@@ -1,8 +1,5 @@
-# Reformat all .ts / .js
-"**/*.(t|j)s":
-  - npm run format:staged
+'{src,test}/**/*.(t|j)s':
   - npm run lint:staged
 
-# sort package.json keys
-./package.json:
-  - sort-package-json
+'./package.json':
+  - sort-package-json