@shgysk8zer0/eslint-config 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+<!-- markdownlint-disable -->
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v1.0.0] - 2024-08-21
+
+Initial Release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Chris Zuber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# eslint-config
+
+A shared ESLint config
+
+[![CodeQL](https://github.com/shgysk8zer0/eslint-config/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/eslint-config/actions/workflows/codeql-analysis.yml)
+![Node CI](https://github.com/shgysk8zer0/eslint-config/workflows/Node%20CI/badge.svg)
+![Lint Code Base](https://github.com/shgysk8zer0/eslint-config/workflows/Lint%20Code%20Base/badge.svg)
+
+[![GitHub license](https://img.shields.io/github/license/shgysk8zer0/eslint-config.svg)](https://github.com/shgysk8zer0/eslint-config/blob/master/LICENSE)
+[![GitHub last commit](https://img.shields.io/github/last-commit/shgysk8zer0/eslint-config.svg)](https://github.com/shgysk8zer0/eslint-config/commits/master)
+[![GitHub release](https://img.shields.io/github/release/shgysk8zer0/eslint-config?logo=github)](https://github.com/shgysk8zer0/eslint-config/releases)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)
+
+[![npm](https://img.shields.io/npm/v/@shgysk8zer0/eslint-config)](https://www.npmjs.com/package/@shgysk8zer0/eslint-config)
+![node-current](https://img.shields.io/node/v/@shgysk8zer0/eslint-config)
+![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@shgysk8zer0/eslint-config)
+[![npm](https://img.shields.io/npm/dw/@shgysk8zer0/eslint-config?logo=npm)](https://www.npmjs.com/package/@shgysk8zer0/eslint-config)
+
+[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)
+![GitHub forks](https://img.shields.io/github/forks/shgysk8zer0/eslint-config.svg?style=social)
+![GitHub stars](https://img.shields.io/github/stars/shgysk8zer0/eslint-config.svg?style=social)
+[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)
+
+[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")
+- - -
+
+- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
+- [Contributing](./.github/CONTRIBUTING.md)
+<!-- - [Security Policy](./.github/SECURITY.md) -->
+
+## Purpose
+
+This package is just to make configuring ESLint easier by providing preset configs for node & browser.
+It also automatically ignores files listed in `.gitignore`.
+
+## Example
+
+```js
+import { node } from '@shgysk8zer0/eslint-config';
+
+export default node();
+```
+
+## Advanced example
+
+```js
+import { rules } from '@shgyk8zer0/eslint-config/rules.js';
+import { ignoreFile } from '@shgysk8zer0/eslint-config/ignoreFile.js';
+import { languageOptions } from '@shgysk8zer0/eslint-config/languageOptions.js';
+
+export default [
+  ignoreFile,
+  { rules, languageOptions }
+];
+```

package/browser.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+var globals = require('globals');
+var js = require('@eslint/js');
+
+const browser$2 = globals.browser;
+globals.node;
+
+const browser$1 = {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: browser$2,
+};
+
+const rules =  {
+	...js.configs.recommended.rules,
+	'indent': [2, 'tab', { 'SwitchCase': 1 }],
+	'quotes': [2, 'single'],
+	'semi': [2, 'always'],
+	'no-console': 0,
+	'no-async-promise-executor': 0,
+	'no-prototype-builtins': 0,
+	'no-unused-vars': 'error',
+};
+
+var browser = ({ ...config } = {}) => ({ rules, languageOptions: browser$1, ...config });
+
+module.exports = browser;

package/browser.js

@@ -0,0 +1,4 @@
+import { browser as languageOptions} from './languageOptions.js';
+import { rules } from './rules.js';
+
+export default ({ ...config } = {}) => ({ rules, languageOptions, ...config });

package/config.cjs

@@ -0,0 +1,61 @@
+'use strict';
+
+var globals$1 = require('globals');
+var js = require('@eslint/js');
+var compat = require('@eslint/compat');
+
+const browser$2 = globals$1.browser;
+const node$2 = globals$1.node;
+
+var globals = /*#__PURE__*/Object.freeze({
+	__proto__: null,
+	browser: browser$2,
+	node: node$2
+});
+
+const node$1 =  {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: node$2,
+};
+
+const browser$1 = {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: browser$2,
+};
+
+var languageOptions = /*#__PURE__*/Object.freeze({
+	__proto__: null,
+	browser: browser$1,
+	node: node$1
+});
+
+const rules =  {
+	...js.configs.recommended.rules,
+	'indent': [2, 'tab', { 'SwitchCase': 1 }],
+	'quotes': [2, 'single'],
+	'semi': [2, 'always'],
+	'no-console': 0,
+	'no-async-promise-executor': 0,
+	'no-prototype-builtins': 0,
+	'no-unused-vars': 'error',
+};
+
+var nodeConfig = ({ ...config } = {}) => ({ rules, languageOptions: node$1, ...config });
+
+var browserConfig = ({ ...config } = {}) => ({ rules, languageOptions: browser$1, ...config });
+
+const ignoreFile = compat.includeIgnoreFile(`${process.cwd()}/.gitignore`);
+
+const node = config => [ignoreFile, nodeConfig(config)];
+const browser = config => [ignoreFile, browserConfig(config)];
+
+exports.browser = browser;
+exports.browserConfig = browserConfig;
+exports.globals = globals;
+exports.ignoreFile = ignoreFile;
+exports.languageOptions = languageOptions;
+exports.node = node;
+exports.nodeConfig = nodeConfig;
+exports.rules = rules;

package/config.js

@@ -0,0 +1,10 @@
+import nodeConfig from './node.js';
+import browserConfig from './browser.js';
+import { ignoreFile } from './ignoreFile.js';
+
+export { rules } from './rules.js';
+export * as globals from './globals.js';
+export * as languageOptions from './languageOptions.js';
+export const node = config => [ignoreFile, nodeConfig(config)];
+export const browser = config => [ignoreFile, browserConfig(config)];
+export { ignoreFile, nodeConfig, browserConfig };

package/globals.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+var globals = require('globals');
+
+const browser = globals.browser;
+const node = globals.node;
+
+exports.browser = browser;
+exports.node = node;

package/globals.js

@@ -0,0 +1,4 @@
+import globals from 'globals';
+
+export const browser = globals.browser;
+export const node = globals.node;

package/ignoreFile.js

@@ -0,0 +1,3 @@
+import { includeIgnoreFile } from '@eslint/compat';
+
+export const ignoreFile = includeIgnoreFile(`${process.cwd()}/.gitignore`);

package/languageOptions.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+var globals = require('globals');
+
+const browser$1 = globals.browser;
+const node$1 = globals.node;
+
+const node =  {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: node$1,
+};
+
+const browser = {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: browser$1,
+};
+
+exports.browser = browser;
+exports.node = node;

package/languageOptions.js

@@ -0,0 +1,13 @@
+import { node as nodeGlobals, browser as browserGlobals } from './globals.js';
+
+export const node =  {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: nodeGlobals,
+};
+
+export const browser = {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: browserGlobals,
+};

package/node.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+var globals = require('globals');
+var js = require('@eslint/js');
+
+globals.browser;
+const node$2 = globals.node;
+
+const node$1 =  {
+	ecmaVersion: 'latest',
+	sourceType: 'module',
+	globals: node$2,
+};
+
+const rules =  {
+	...js.configs.recommended.rules,
+	'indent': [2, 'tab', { 'SwitchCase': 1 }],
+	'quotes': [2, 'single'],
+	'semi': [2, 'always'],
+	'no-console': 0,
+	'no-async-promise-executor': 0,
+	'no-prototype-builtins': 0,
+	'no-unused-vars': 'error',
+};
+
+var node = ({ ...config } = {}) => ({ rules, languageOptions: node$1, ...config });
+
+module.exports = node;

package/node.js

@@ -0,0 +1,4 @@
+import { node as languageOptions} from './languageOptions.js';
+import { rules } from './rules.js';
+
+export default ({ ...config } = {}) => ({ rules, languageOptions, ...config });

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@shgysk8zer0/eslint-config",
+  "version": "1.0.0",
+  "description": " A shared ESLint config",
+  "keywords": ["eslint", "eslint-config"],
+  "type": "module",
+  "main": "./config.cjs",
+  "module": "./config.js",
+  "exports": {
+    ".": {
+      "import": "./config.js",
+      "require": "./config.cjs"
+    },
+    "./*.js": {
+      "import": "./*.js",
+      "require": "./*.cjs"
+    },
+    "./*.mjs": {
+      "import": "./*.js",
+      "require": "./*.cjs"
+    },
+    "./*.cjs": {
+      "import": "./*.js",
+      "require": "./*.cjs"
+    },
+    "./*": {
+      "import": "./*.js",
+      "require": "./*.cjs"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "private": false,
+  "scripts": {
+    "test": "npm run lint:js",
+    "preversion": "npm test && npm run build",
+    "prepare": "npm test && npm run build",
+    "lint": "npm run lint:js",
+    "lint:js": "eslint -c 'eslint.config.js' .",
+    "fix:js": "eslint . --fix",
+    "build": "npm run build:js",
+    "clean": "rm -f ./*.cjs",
+    "build:js": "npm run clean && rollup -c rollup.config.js",
+    "create:lock": "npm i --package-lock-only --ignore-scripts --no-audit --no-fund",
+    "version:bump": "npm run version:bump:patch",
+    "version:bump:patch": "npm version --no-git-tag-version patch && npm run create:lock",
+    "version:bump:minor": "npm version --no-git-tag-version minor && npm run create:lock",
+    "version:bump:major": "npm version --no-git-tag-version major && npm run create:lock"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shgysk8zer0/eslint-config.git"
+  },
+  "author": "Chris Zuber <admin@kernvalley.us>",
+  "license": "MIT",
+  "funding": [
+    {
+      "type": "librepay",
+      "url": "https://liberapay.com/shgysk8zer0"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/shgysk8zer0"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/shgysk8zer0/eslint-config/issues"
+  },
+  "homepage": "https://github.com/shgysk8zer0/eslint-config#readme",
+  "dependencies": {
+    "@eslint/compat": "^1.1.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "eslint": "^9.9.0",
+    "rollup": "^4.21.0"
+  }
+}

package/rules.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+var js = require('@eslint/js');
+
+const rules =  {
+	...js.configs.recommended.rules,
+	'indent': [2, 'tab', { 'SwitchCase': 1 }],
+	'quotes': [2, 'single'],
+	'semi': [2, 'always'],
+	'no-console': 0,
+	'no-async-promise-executor': 0,
+	'no-prototype-builtins': 0,
+	'no-unused-vars': 'error',
+};
+
+exports.rules = rules;

package/rules.js

@@ -0,0 +1,12 @@
+import js from '@eslint/js';
+
+export const rules =  {
+	...js.configs.recommended.rules,
+	'indent': [2, 'tab', { 'SwitchCase': 1 }],
+	'quotes': [2, 'single'],
+	'semi': [2, 'always'],
+	'no-console': 0,
+	'no-async-promise-executor': 0,
+	'no-prototype-builtins': 0,
+	'no-unused-vars': 'error',
+};