lintroll 0.0.0 → 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hiroki Osame <hiroki.osame@gmail.com>
+
+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,257 @@
+<p align="center">
+	<img src="./.github/logo.webp" width="120">
+</p>
+<h2 align="center">
+lintroll
+<br>
+<a href="https://npm.im/lintroll"><img src="https://badgen.net/npm/v/lintroll"></a>
+</h2>
+
+An opinionated JavaScript, TypeScript, Vue.js, React, etc. linter.
+
+Powered by ESLint that's enhanced with 12 plugins, covering a wide scope including TypeScript, React, Vue.js, JSON & YAML, and even Markdown code blocks.
+
+### Features
+
+- **Streamlined syntax**: Single quotes, semicolons, tabs, and [arrow functions](./src/custom-rules/prefer-arrow-functions/) for a clear & intentional coding style.
+
+- **Versatile language support**: Lints TypeScript, Vue.js, React, JSON & YAML, and even Markdown code blocks ensuring a wide scope of code.
+
+- **CLI command** Comes with a quick and easy-to-use CLI command, which even supports `eslint.config.ts`.
+
+- **ESLint config**: Also exports an ESLint config so you can itegrate it into your own config!
+
+### What does the linted code look like?
+Checkout the code fixtures from the passing tests [here](https://github.com/search?q=repo%3Aprivatenumber%2Feslint-config+path%3Atests%2F**%2Ffixtures%2Fpass*&type=code).
+
+## Install
+
+```sh
+npm i -D lintroll
+```
+
+## Using as a CLI command
+
+The `lintroll` command can be used as drop-in replacement for `eslint`, allowing you to lint your code with this config without any extra configuration.
+
+#### Lint files in the current directory
+
+```sh
+lintroll .
+```
+
+#### Apply auto fix
+
+```sh
+lintroll . --fix
+```
+
+#### Lint with caching enabled
+```sh
+lintroll --cache .
+```
+
+#### Lint only staged files
+```sh
+lintroll --staged .
+```
+
+#### Specify Node.js files
+```sh
+lintroll --node=./build .
+```
+
+### Optional `package.json` script
+
+Adding it to `package.json#scripts` allows you to simply run `npm run lint` (or `pnpm lint`) without needing to pass in the current directory (`.`) every time.
+
+This also follows the best practice of documenting available commands in a central place.
+
+```diff
+  "scripts": {
++   "lint": "lintroll .",
+    "build": "..."
+    "dev": "..."
+  }
+```
+### Configuration
+
+If you'd like to customize the linting rules further, you can add one of these ESLint config files to your project root and `lint` will detect them automatically:
+
+- `eslint.config.ts`: The typed version of the configuration file, ideal if you are working with TypeScript.
+
+- `eslint.config.js`: A standard JavaScript file for ESLint configuration, suitable for projects not using TypeScript.
+
+> [!NOTE]
+> When creating your own ESLint config file, you must manually add the `pvtnbr` config. Read the section below to learn how.
+
+### `--help`
+```
+lintroll
+
+by @privatenumber (Hiroki Osame)
+
+Usage:
+  lintroll [flags...] <files...>
+
+Flags:
+      --cache                          Only check changed files
+      --cache-location <string>        Path to the cache file or directory
+      --fix                            Automatically fix problems
+  -h, --help                           Show help
+      --ignore-pattern <string>        Pattern of files to ignore
+      --node <string>                  Enable Node.js rules. Pass in a glob to specify files
+      --quiet                          Report errors only
+      --staged                         Only lint staged files within the files passed in
+```
+
+## Using as an ESLint config
+
+To use the `eslint` command, create a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) file `eslint.config.js` at your project root.
+
+> [!TIP]
+> If you'd like to use TypeScript for your config file (`eslint.config.ts`), use the `lint` command from the previous section. The `eslint` command only supports `eslint.config.js`.
+
+### Simple config
+If you want a simple setup with no customization, create the following `eslint.config.js`:
+
+Module:
+```js
+export { default } from 'lintroll'
+```
+
+CommonJS:
+```js
+module.exports = require('lintroll')
+```
+
+### Extended config
+
+In `eslint.config.js`:
+
+Module:
+```js
+// @ts-check
+
+import { defineConfig, pvtnbr } from 'lintroll'
+
+export default defineConfig([
+    {
+        // Don't lint these files
+        ignores: [
+            'tests/fixtures/**/*'
+        ]
+    },
+
+    // Configure the pvtnbr config
+    ...pvtnbr({
+
+        // Indicate Node.js project
+        node: true,
+
+        // Indicate Vue.js project (auto-detected by default)
+        vue: true
+    })
+
+    // Other configs...
+])
+```
+
+CommonJS:
+```js
+// @ts-check
+
+const { defineConfig, pvtnbr } = require('lintroll')
+
+module.exports = defineConfig([
+    {
+        // Don't lint these files
+        ignores: [
+            'tests/fixtures/**/*'
+        ]
+    },
+
+    // Configure the pvtnbr config
+    ...pvtnbr({
+
+        // Indicate Node.js project or pass in file paths
+        node: true
+    })
+
+    // Other configs...
+])
+```
+
+> [!TIP]
+> If you'd like to type check your `eslint.config.js` file, you can add [`// @ts-check`](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check) to the top.
+
+
+## Linting coverage
+
+This ESLint config comprehensively supports a variety of languages and file types, ensuring coding standards and best practices across your project.
+
+| Language/File Type | Extensions |
+| ------------------ | -------------------- |
+| JavaScript | `.js`, `.cjs`, `.mjs` |
+| Node.js | `.cjs`, `.mjs` |
+| Service Workers | `.sw.js`, `.sw.ts` |
+| TypeScript | `.ts`, `.cts`, `.mts`, `.d.ts` |
+| Vue.js | `.vue` |
+| React | `.jsx`, `.tsx` |
+| JSON | `.json`, `.json5`, `.jsonc` |
+| YML | `.yml`, `.yaml` |
+| Markdown | `.md` |
+
+
+### Integrated plugins
+
+Each plugin in this ESLint configuration targets specific aspects of your code, ensuring quality and consistency.
+
+| Plugin | Focus area |
+| ------ | ---------- |
+| [eslint-comments](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments) | ESLint directive comments |
+| [node](https://www.npmjs.com/package/eslint-plugin-node) | Node.js coding practices |
+| [@typescript-eslint](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) | TypeScript coding Practices |
+| [@stylistic](https://www.npmjs.com/package/@stylistic/eslint-plugin) | JavaScript & TypeScript code style |
+| [promise](https://www.npmjs.com/package/eslint-plugin-promise) | Promises best practices |
+| [regexp](https://www.npmjs.com/package/eslint-plugin-regexp) | Regular Expressions best practices |
+| [import](https://www.npmjs.com/package/eslint-plugin-import) | ES6+ Import/Export |
+| [jsonc](https://www.npmjs.com/package/eslint-plugin-jsonc) | JSON, JSON5, and JSONC style |
+| [yml](https://www.npmjs.com/package/eslint-plugin-yml) | YAML style |
+| [vue](https://www.npmjs.com/package/eslint-plugin-vue) | Vue.js Templates & Scripts |
+| [react](https://www.npmjs.com/package/eslint-plugin-react) <!--& [react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)--> | React best practices<!--& React Hooks--> |
+| [markdown](https://www.npmjs.com/package/eslint-plugin-markdown) | Markdown embedded code blocks |
+| [no-use-extend-native](https://www.npmjs.com/package/eslint-plugin-no-use-extend-native) | Native prototype extensions |
+| [unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) | Miscellaneous code quality rules |
+| [Custom](https://github.com/privatenumber/eslint-config/tree/develop/src/custom-rules) | Custom rules made for this config |
+
+## API
+
+### pvtbr(options)
+
+The main config factory. It takes an object of options and returns a config object.
+
+#### options.node
+
+Type: `boolean | string[]`
+
+Default: `false`
+
+Whether to lint Node.js code. When `true`, it will treat all files as Node.js files. You can also pass in an array of glob patterns to specify which files are Node.js files.
+
+### defineConfig(configs)
+
+An identity function to enforce type checking on the config.
+
+#### configs
+
+Type: `FlatConfig | FlatConfig[]`
+
+## Awesome ESLint configs
+
+Make sure you also check out these awesome ESLint configs. They are a constant source of inspiration for me, and are great alternatives to consider.
+
+- [antfu/eslint-config](https://github.com/antfu/eslint-config) by [@antfu](https://github.com/antfu)
+- [sxzz/eslint-config](https://github.com/sxzz/eslint-config) by [@sxzz](https://github.com/sxzz)
+- [@ota-meshi/eslint-plugin](https://github.com/ota-meshi/eslint-plugin) by [@ota-meshi](https://github.com/ota-meshi)
+- [standard config](https://github.com/standard/eslint-config-standard) by [@feross](https://github.com/feross)

package/dist/cli/index.cjs

@@ -0,0 +1,2 @@
+"use strict";require("tsx/esm");var c=require("path"),h=require("cleye"),y=require("eslint/use-at-your-own-risk"),f=require("execa"),l=require("../index-DRoRpPeV.cjs"),m=require("url"),v=require("fs/promises");require("@eslint/js"),require("globals"),require("confusing-browser-globals"),require("module"),require("@eslint-community/eslint-plugin-eslint-comments"),require("@stylistic/eslint-plugin"),require("eslint-plugin-import-x"),require("@typescript-eslint/eslint-plugin"),require("@typescript-eslint/parser"),require("eslint-plugin-regexp"),require("node:fs"),require("eslint-plugin-n"),require("node:path"),require("../index-BsUJzcDL.cjs"),require("node:process"),require("node:fs/promises"),require("node:url"),require("tty"),require("os"),require("util"),require("eslint-plugin-promise"),require("eslint-plugin-markdown"),require("eslint-plugin-jsonc"),require("eslint-plugin-yml"),require("yaml-eslint-parser"),require("eslint-plugin-no-use-extend-native"),require("eslint-plugin-unicorn"),require("eslint-plugin-react"),require("eslint-plugin-react-hooks"),require("get-tsconfig"),require("fs"),require("eslint-plugin-vue"),require("vue-eslint-parser"),require("eslint");const g=async e=>v.access(e).then(()=>e,()=>{}),w=async e=>{const r=await g("eslint.config.ts")??await g("eslint.config.js");if(r){const t=await import(m.pathToFileURL(r).toString());if(t.default)return console.log(`[${l.name}]: Using config file: ${r}`),t.default}return l.pvtnbr(e)},x=e=>{let r=0,t=0,o=0;for(const n of e)r+=n.errorCount,t+=n.fatalErrorCount,o+=n.warningCount;return{errorCount:r,fatalErrorCount:t,warningCount:o}},C=e=>e.fatalErrorCount>0?2:e.errorCount>0?1:0,i=h.cli({name:l.name,parameters:["<files...>"],help:{description:"Opinionated ESLint by @privatenumber (Hiroki Osame)"},flags:{fix:{type:Boolean,description:"Automatically fix problems"},staged:{type:Boolean,description:"Only lint staged files within the files passed in"},quiet:{type:Boolean,description:"Report errors only"},cache:{type:Boolean,description:"Only check changed files"},cacheLocation:{type:String,description:"Path to the cache file or directory"},ignorePattern:{type:[String],description:"Pattern of files to ignore"},node:{type:[String],description:"Enable Node.js rules. Pass in a glob to specify files"}}}),E=e=>{if(e.length===0)return!1;const r=e.filter(t=>t.length>0);return r.length>0?r:!0};(async()=>{const{FlatESLint:e}=y,r=new e({baseConfig:await w({node:E(i.flags.node)}),overrideConfigFile:!0,fix:i.flags.fix,cache:i.flags.cache,cacheLocation:i.flags.cacheLocation,ignorePatterns:i.flags.ignorePattern});let t=i._.files.map(s=>c.resolve(s));if(i.flags.staged)try{const{stdout:s}=await f.execa("git",["rev-parse","--show-toplevel"]),{stdout:d}=await f.execa("git",["diff","--staged","--name-only","--diff-filter=ACMR"]);t=d.split(`
+`).filter(Boolean).map(a=>c.resolve(s,a)).filter(a=>t.some(p=>a.startsWith(p)))}catch{console.error("Error: Failed to detect staged files from git"),process.exit(1)}const o=await r.lintFiles(t);i.flags.fix&&await e.outputFixes(o);let n=o;i.flags.quiet&&(n=e.getErrorResults(o));const q=x(o),u=await(await r.loadFormatter()).format(n);u&&console.log(u),process.exitCode=C(q)})();

package/dist/cli/index.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import"tsx/esm";import p from"path";import{cli as h}from"cleye";import y from"eslint/use-at-your-own-risk";import{execa as c}from"execa";import{n as f,p as w}from"../index-jdY9gLh9.mjs";import{pathToFileURL as C}from"url";import x from"fs/promises";import"@eslint/js";import"globals";import"confusing-browser-globals";import"module";import"@eslint-community/eslint-plugin-eslint-comments";import"@stylistic/eslint-plugin";import"eslint-plugin-import-x";import"@typescript-eslint/eslint-plugin";import"@typescript-eslint/parser";import"eslint-plugin-regexp";import"node:fs";import"eslint-plugin-n";import"node:path";import"../index-DW7ozoHd.mjs";import"node:process";import"node:fs/promises";import"node:url";import"tty";import"os";import"util";import"eslint-plugin-promise";import"eslint-plugin-markdown";import"eslint-plugin-jsonc";import"eslint-plugin-yml";import"yaml-eslint-parser";import"eslint-plugin-no-use-extend-native";import"eslint-plugin-unicorn";import"eslint-plugin-react";import"eslint-plugin-react-hooks";import"get-tsconfig";import"fs";import"eslint-plugin-vue";import"vue-eslint-parser";import"eslint";const m=async t=>x.access(t).then(()=>t,()=>{}),E=async t=>{const o=await m("eslint.config.ts")??await m("eslint.config.js");if(o){const e=await import(C(o).toString());if(e.default)return console.log(`[${f}]: Using config file: ${o}`),e.default}return w(t)},F=t=>{let o=0,e=0,r=0;for(const n of t)o+=n.errorCount,e+=n.fatalErrorCount,r+=n.warningCount;return{errorCount:o,fatalErrorCount:e,warningCount:r}},b=t=>t.fatalErrorCount>0?2:t.errorCount>0?1:0,i=h({name:f,parameters:["<files...>"],help:{description:"Opinionated ESLint by @privatenumber (Hiroki Osame)"},flags:{fix:{type:Boolean,description:"Automatically fix problems"},staged:{type:Boolean,description:"Only lint staged files within the files passed in"},quiet:{type:Boolean,description:"Report errors only"},cache:{type:Boolean,description:"Only check changed files"},cacheLocation:{type:String,description:"Path to the cache file or directory"},ignorePattern:{type:[String],description:"Pattern of files to ignore"},node:{type:[String],description:"Enable Node.js rules. Pass in a glob to specify files"}}}),v=t=>{if(t.length===0)return!1;const o=t.filter(e=>e.length>0);return o.length>0?o:!0};(async()=>{const{FlatESLint:t}=y,o=new t({baseConfig:await E({node:v(i.flags.node)}),overrideConfigFile:!0,fix:i.flags.fix,cache:i.flags.cache,cacheLocation:i.flags.cacheLocation,ignorePatterns:i.flags.ignorePattern});let e=i._.files.map(s=>p.resolve(s));if(i.flags.staged)try{const{stdout:s}=await c("git",["rev-parse","--show-toplevel"]),{stdout:d}=await c("git",["diff","--staged","--name-only","--diff-filter=ACMR"]);e=d.split(`
+`).filter(Boolean).map(a=>p.resolve(s,a)).filter(a=>e.some(u=>a.startsWith(u)))}catch{console.error("Error: Failed to detect staged files from git"),process.exit(1)}const r=await o.lintFiles(e);i.flags.fix&&await t.outputFixes(r);let n=r;i.flags.quiet&&(n=t.getErrorResults(r));const g=F(r),l=await(await o.loadFormatter()).format(n);l&&console.log(l),process.exitCode=b(g)})();

package/dist/index-BsUJzcDL.cjs

@@ -0,0 +1 @@
+"use strict";var l=require("node:process");require("node:fs/promises");var u=require("node:url"),d=require("node:fs"),i=require("node:path");const f=r=>r instanceof URL?u.fileURLToPath(r):r;function y(r,{cwd:a=l.cwd(),type:o="file",stopAt:t}={}){let e=i.resolve(f(a)??"");const{root:s}=i.parse(e);for(t=i.resolve(e,f(t)??s);e&&e!==t&&e!==s;){const c=i.isAbsolute(r)?r:i.join(e,r);try{const n=d.statSync(c,{throwIfNoEntry:!1});if(o==="file"&&n?.isFile()||o==="directory"&&n?.isDirectory())return c}catch{}e=i.dirname(e)}}exports.findUpSync=y;