@isentinel/eslint-config 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-PRESENT Anthony Fu<https://github.com/antfu>
+
+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,286 @@
+# @isentinel/eslint-config
+
+<!-- - Single quotes, no semi
+- Auto fix for formatting (aimed to be used standalone **without** Prettier)
+- Designed to work with TypeScript, JSX, Vue out-of-box
+- Lints also for json, yaml, markdown
+- Sorted imports, dangling commas
+- Reasonable defaults, best practices, only one-line of config
+- Opinionated, but [very customizable](#customization)
+- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
+- Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
+- Respects `.gitignore` by default
+- Optional [formatters](#formatters) support for CSS, HTML, TOML, etc.
+- **Style principle**: Minimal for reading, stable for diff, consistent -->
+
+<!-- > [!IMPORTANT]
+> Since v1.0.0, this config is rewritten to the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), check the [release note](https://github.com/antfu/eslint-config/releases/tag/v1.0.0) for more details. -->
+
+## Usage
+
+### Install
+
+```bash
+npm i -D eslint @isentinel/eslint-config
+```
+
+### Create config file
+
+With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+
+```js
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style();
+```
+
+> Note that `.eslintignore` no longer works in Flat config, see
+> [customization](#customization) for more details.
+
+> [!TIP]
+> ESLint only detects `eslint.config.js` as the flat config entry, meaning you need to put `type: module` in your `package.json`. `eslint.config.ts`, you can install [`eslint-ts-patch`](https://github.com/antfu/eslint-ts-patch) to fix it.
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+	"scripts": {
+		"lint": "eslint .",
+		"lint:fix": "eslint . --fix"
+	}
+}
+```
+
+## VS Code support (auto fix)
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+Add the following settings to your `.vscode/settings.json`:
+
+```json
+{
+	// Enable the ESlint flat config support
+	"eslint.experimental.useFlatConfig": true,
+
+	"editor.formatOnSave": false,
+
+	// Auto fix
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "always",
+		"source.organizeImports": "never"
+	},
+
+	// Silent the stylistic rules in you IDE, but still auto fix them
+	"eslint.rules.customizations": [
+		{ "rule": "style/*", "severity": "off" },
+		{ "rule": "format/*", "severity": "off" },
+		{ "rule": "*-indent", "severity": "off" },
+		{ "rule": "*-spacing", "severity": "off" },
+		{ "rule": "*-spaces", "severity": "off" },
+		{ "rule": "*-order", "severity": "off" },
+		{ "rule": "*-dangle", "severity": "off" },
+		{ "rule": "*-newline", "severity": "off" },
+		{ "rule": "*quotes", "severity": "off" },
+		{ "rule": "*semi", "severity": "off" }
+	],
+
+	// Enable eslint for all supported languages
+	"eslint.validate": [
+		"typescript",
+		"typescriptreact",
+		"markdown",
+		"json",
+		"jsonc",
+		"yaml"
+	]
+}
+```
+
+## Customization
+
+Normally you only need to import the `style` preset:
+
+```ts
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style();
+```
+
+And that's it! Or you can configure each integration individually, for example:
+
+```ts
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style({
+	// `.eslintignore` is no longer supported in Flat config, use `ignores`
+	// instead
+	ignores: [
+		"./fixtures",
+		// ...globs
+	],
+
+	// Provide TypeScript parser options for access to type checking lints.
+	typescript: {
+		parserOptions: {
+			ecmaVersion: 2018,
+			jsx: true,
+			sourceType: "module",
+			useJSXTextNode: true,
+		},
+		tsconfigPath: "./tsconfig.json",
+	},
+
+	// Disable yaml support
+	yaml: false,
+});
+```
+
+The `style` factory function also accepts any number of arbitrary custom config overrides:
+
+```ts
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style(
+	{
+		// Configures for isentinel's config
+	},
+
+	// From the second arguments they are ESLint Flat Configs
+	// you can have multiple configs
+	{
+		files: ["**/*.ts"],
+		rules: {},
+	},
+	{
+		rules: {},
+	},
+);
+```
+
+Check out the [configs](https://github.com/christopher-buss/roblox-ts-eslint-config/tree/main/src/configs) and [factory](https://github.com/christopher-buss/roblox-ts-eslint-config/blob/main/src/factory.ts) for more details.
+
+> Thanks to [antfu/eslint-config](https://github.com/antfu/eslint-config) and [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.
+
+### Plugins Renaming
+
+Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
+
+| New Prefix | Original Prefix        | Source Plugin                                                                              |
+| ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `import/*` | `i/*`                  | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i)                                |
+| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                     |
+| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                        |
+| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
+
+When you want to override rules, or disable them inline, you need to update to the new prefix:
+
+```diff
+-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
++// eslint-disable-next-line ts/consistent-type-definitions
+type foo = { bar: 2 }
+```
+
+### Optional Configs
+
+We provide some optional configs for specific use cases, that we don't include their dependencies by default.
+
+#### React
+
+To enable React support, you need to explicitly turn it on:
+
+```js
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style({
+	react: true,
+});
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-react eslint-plugin-react-hooks
+```
+
+### Optional Rules
+
+This config also provides some optional plugins/rules for extended usages.
+
+#### `perfectionist` (sorting)
+
+This plugin [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) allows you to sorted object keys, imports, etc, with auto-fix.
+
+The plugin is installed and some rules are enabled by default, but these rules
+can be disabled or overridden by your own config. For example, I personally have
+sort-objects set to:
+
+```js
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style({
+	rules: {
+		"perfectionist/sort-objects": [
+			"warn",
+			{
+				"custom-groups": {
+					id: "id",
+					name: "name",
+					"react-props": ["children", "ref"],
+				},
+				groups: ["id", "name", "unknown", "react-props"],
+				order: "asc",
+				"partition-by-comment": "Part:**",
+				type: "natural",
+			},
+		],
+	},
+});
+```
+
+### Lint Staged
+
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+	"simple-git-hooks": {
+		"pre-commit": "npm lint-staged"
+	},
+	"lint-staged": {
+		"*": "eslint --fix"
+	}
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## View what rules are enabled
+
+There is a visual tool to help you view what rules are enabled in your project and apply them to what files, [eslint-flat-config-viewer](https://github.com/antfu/eslint-flat-config-viewer)
+
+Go to your project root that contains `eslint.config.ts` and run:
+
+```bash
+npx eslint-flat-config-viewer
+```
+
+### I prefer XXX...
+
+Sure, you can configure and override rules locally in your project to fit your
+needs. If that still does not work for you, you can always fork this repo and
+maintain your own. I am open to PRs that help improve the overall experience for
+developers, and there may still be rules activated that do not apply to the
+roblox-ts ecosystem.

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../dist/cli.js";