feat: initial release

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+      - alpha
+      - beta
+      - next
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm install
+
+      - run: npm run lint
+
+      - run: npx semantic-release
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on:
+  push:
+    branches-ignore:
+      - main
+      - alpha
+      - beta
+      - next
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm install
+
+      - run: npm run lint

.gitignore

@@ -0,0 +1 @@
+node_modules/

.npmrc

@@ -0,0 +1,2 @@
+package-lock=false
+save-exact=true

.prettierrc.json

@@ -0,0 +1,12 @@
+{
+  "useTabs": true,
+  "overrides": [
+    {
+      "files": ["*.yml", "*.json"],
+      "options": {
+        "tabWidth": 2,
+        "useTabs": false
+      }
+    }
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+Thank you for showing an interest in contributing to Eik 🧡
+
+This module is a [shared config for ESLint](https://eslint.org/docs/latest/extend/shareable-configs). We accept changes that should apply to all repositories in the [eik-lib origanisation](https://github.com/eik-lib).
+
+Commits should follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
+
+A change in configuration is considered a `patch` in [semantic versioning](https://semver.org/). A new export would be a `minor`. Updating the `peerDependency` to a higher version would be a `major`.
+
+This repo uses [semantic release](https://github.com/semantic-release/semantic-release) to automate releases whenever changes are merged to the default branch.

README.md

@@ -0,0 +1,26 @@
+# @eik/eslint-config
+
+Shared config for ESLint used in Eik projects.
+
+## Install
+
+```
+npm install --save-dev eslint @eik/eslint-config
+```
+
+## Usage
+
+The default config should cover most needs, but you can extend or override if you need to.
+
+```js
+// eslint.config.js
+
+import config from "@eik/eslint-config";
+
+export default [
+	...config,
+	/* Your customisations */
+];
+```
+
+If you do need to change the config, consider whether that change should happen here in the shared config so it applies to all repos.

eslint.config.js

@@ -0,0 +1,3 @@
+import eikEslintConfig from "./lib/default.js";
+
+export default [...eikEslintConfig];

lib/base.js

@@ -0,0 +1,12 @@
+import prettierConfig from "eslint-config-prettier";
+import prettierPlugin from "eslint-plugin-prettier/recommended";
+import js from "@eslint/js";
+
+export default [
+	js.configs.recommended,
+	prettierConfig,
+	prettierPlugin,
+	{
+		ignores: ["coverage/*", "node_modules/*", "tap-snapshots/*"],
+	},
+];

lib/default.js

@@ -0,0 +1,14 @@
+import globals from "globals";
+import base from "./base.js";
+
+export default [
+	...base,
+	{
+		languageOptions: {
+			globals: {
+				...globals.node,
+				...globals.browser,
+			},
+		},
+	},
+];

package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@eik/eslint-config",
+  "version": "1.0.0",
+  "description": "Shared ESLint config for Eik modules",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./lib/default.js"
+    }
+  },
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/eik-lib/eslint-config.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/eik-lib/eslint-config/issues"
+  },
+  "homepage": "https://github.com/eik-lib/eslint-config#readme",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig"
+  ],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "eslint": ">= 9"
+  },
+  "dependencies": {
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "globals": "15.8.0"
+  },
+  "devDependencies": {
+    "eslint": "9.8.0"
+  }
+}