feat(flat-config)!: migrate to flat config and update rules (#2)

Author: OliverDudgeon

.eslintrc.js

@@ -0,0 +1,20 @@
+on:
+  push:
+    branches:
+    - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: google-github-actions/release-please-action@v4
+      with:
+        token: ${{ secrets.RELEASE_PLEASE_PAT_OLIVER }}
+        config-file: release-please-config.json
+

.github/workflows/release-please.yaml

@@ -0,0 +1,11 @@
+{
+  "trailingComma": "all",
+  "singleQuote": false,
+  "printWidth": 100,
+  "semi": true,
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "useTabs": false,
+  "tabWidth": 2
+}

.prettierrc

@@ -1,4 +1,5 @@
 # eslint-config-squonk
+
 ESLint config used by Squonk front-end apps
 
 ## Installation
@@ -11,29 +12,16 @@ This assumes you are using `pnpm`.
 pnpm add -D eslint @squonk/eslint-config
 ```
 
-2. Create (or modify) a `.eslintrc.js` (or `.eslintrc.cjs` if your `package.json` is to `"type": "module"`) file with the following:
+2. Create (or modify) a `eslint.config.js` for your _flat_ eslint config file and merge the configs you need for the project:
 
 ```js
-/**
- * @type {import("eslint").Linter.Config}
- */
-module.exports = {
-  parserOptions: {
-    project: "tsconfig.json",
-    tsconfigRootDir: __dirname,
-  },
-  extends: ["@squonk/eslint-config"],
-};
-```
+import config from "@squonk/eslint-config";
 
-3. You will need to ensure your `tsconfig.json` `includes` the all files you wish to be linted to prevent errors. Ensure it has the following entry to format dotfiles too:
-
-```json
-"include": [
-    ...,
-  ]
+export default config.map((c) => ({ ...c, ignores: ["**/dist/**"] }));
 ```
 
+Add any files and directories you wish to ignore since .eslintignore is removed for flat configs.
+
 4. Install peer dependencies or (preferred) set `--resolve--resolve-plugins-relative-to="path/to/@squonk/eslint-config"` (may be a monorepo or the node-modules folder)
 
 ## Development