@jpp-toolkit/plugin-lint 0.0.11

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Julien Papini
+
+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/dist/index.d.mts

@@ -0,0 +1,24 @@
+import { Command } from "@jpp-toolkit/core";
+import * as _oclif_core_interfaces0 from "@oclif/core/interfaces";
+
+//#region src/lint-command.d.ts
+declare class LintCommand extends Command {
+  static summary: string;
+  static flags: {
+    format: _oclif_core_interfaces0.BooleanFlag<boolean>;
+    root: _oclif_core_interfaces0.BooleanFlag<boolean>;
+  };
+  static examples: {
+    description: string;
+    command: string;
+  }[];
+  run(): Promise<void>;
+}
+//#endregion
+//#region src/index.d.ts
+declare const commands: {
+  lint: typeof LintCommand;
+};
+//#endregion
+export { commands };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,73 @@
+import { Command } from "@jpp-toolkit/core";
+import { buildEslintArgs, buildPrettierArgs, findProjectRoot } from "@jpp-toolkit/utils";
+import { Flags } from "@oclif/core";
+import { execa } from "execa";
+
+//#region src/lint-command.ts
+var LintCommand = class LintCommand extends Command {
+	static summary = "Run code linting on the project source code.";
+	static flags = {
+		format: Flags.boolean({
+			char: "f",
+			description: "Automatically fix linting issues.",
+			default: false
+		}),
+		root: Flags.boolean({
+			char: "R",
+			description: "Lint from the project root directory.",
+			default: false
+		})
+	};
+	static examples = [
+		{
+			description: "Run the lint command.",
+			command: "<%= config.bin %> <%= command.id %>"
+		},
+		{
+			description: "Run the lint command and automatically fix issues.",
+			command: "<%= config.bin %> <%= command.id %> --format"
+		},
+		{
+			description: "Run the lint command from the project root directory.",
+			command: "<%= config.bin %> <%= command.id %> --root"
+		}
+	];
+	async run() {
+		const { flags } = await this.parse(LintCommand);
+		const cwd = flags.root ? findProjectRoot() : process.cwd();
+		const mode = flags.format ? "formatting" : "linting";
+		this.logger.info(`Running Prettier ${mode}...`);
+		const prettierResult = await execa("prettier", buildPrettierArgs({ format: flags.format }), {
+			cwd,
+			stdio: "inherit",
+			preferLocal: true,
+			reject: false
+		});
+		if (prettierResult.failed) this.logger.error(`Prettier ${mode} failed.`);
+		else this.logger.success(`Prettier ${mode} completed successfully.`);
+		this.logger.log();
+		this.logger.info(`Running ESLint ${mode}...`);
+		const eslintResult = await execa("eslint", buildEslintArgs({ format: flags.format }), {
+			cwd,
+			stdio: "inherit",
+			preferLocal: true,
+			reject: false
+		});
+		if (eslintResult.failed) this.logger.error(`ESLint ${mode} failed.`);
+		else this.logger.success(`ESLint ${mode} completed successfully.`);
+		this.logger.log();
+		if (!prettierResult.failed && !eslintResult.failed) this.logger.success(`Linting process completed successfully.`);
+		else {
+			this.logger.error(`Linting process encountered issues.`);
+			process.exit(1);
+		}
+	}
+};
+
+//#endregion
+//#region src/index.ts
+const commands = { lint: LintCommand };
+
+//#endregion
+export { commands };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/lint-command.ts","../src/index.ts"],"sourcesContent":["import { Command } from '@jpp-toolkit/core';\nimport { buildEslintArgs, buildPrettierArgs, findProjectRoot } from '@jpp-toolkit/utils';\nimport { Flags } from '@oclif/core';\nimport { execa } from 'execa';\n\nexport class LintCommand extends Command {\n    static override summary = 'Run code linting on the project source code.';\n\n    static override flags = {\n        format: Flags.boolean({\n            char: 'f',\n            description: 'Automatically fix linting issues.',\n            default: false,\n        }),\n        root: Flags.boolean({\n            char: 'R',\n            description: 'Lint from the project root directory.',\n            default: false,\n        }),\n    };\n\n    static override examples = [\n        {\n            description: 'Run the lint command.',\n            command: '<%= config.bin %> <%= command.id %>',\n        },\n        {\n            description: 'Run the lint command and automatically fix issues.',\n            command: '<%= config.bin %> <%= command.id %> --format',\n        },\n        {\n            description: 'Run the lint command from the project root directory.',\n            command: '<%= config.bin %> <%= command.id %> --root',\n        },\n    ];\n\n    public async run(): Promise<void> {\n        const { flags } = await this.parse(LintCommand);\n\n        const cwd = flags.root ? findProjectRoot() : process.cwd();\n        const mode = flags.format ? 'formatting' : 'linting';\n\n        this.logger.info(`Running Prettier ${mode}...`);\n        const prettierResult = await execa(\n            'prettier',\n            buildPrettierArgs({ format: flags.format }),\n            {\n                cwd,\n                stdio: 'inherit',\n                preferLocal: true,\n                reject: false,\n            },\n        );\n        if (prettierResult.failed) this.logger.error(`Prettier ${mode} failed.`);\n        else this.logger.success(`Prettier ${mode} completed successfully.`);\n        this.logger.log();\n\n        this.logger.info(`Running ESLint ${mode}...`);\n        const eslintResult = await execa('eslint', buildEslintArgs({ format: flags.format }), {\n            cwd,\n            stdio: 'inherit',\n            preferLocal: true,\n            reject: false,\n        });\n        if (eslintResult.failed) this.logger.error(`ESLint ${mode} failed.`);\n        else this.logger.success(`ESLint ${mode} completed successfully.`);\n        this.logger.log();\n\n        if (!prettierResult.failed && !eslintResult.failed) {\n            this.logger.success(`Linting process completed successfully.`);\n        } else {\n            this.logger.error(`Linting process encountered issues.`);\n            process.exit(1);\n        }\n    }\n}\n","import { LintCommand } from './lint-command';\n\nexport const commands = {\n    lint: LintCommand,\n};\n"],"mappings":";;;;;;AAKA,IAAa,cAAb,MAAa,oBAAoB,QAAQ;CACrC,OAAgB,UAAU;CAE1B,OAAgB,QAAQ;EACpB,QAAQ,MAAM,QAAQ;GAClB,MAAM;GACN,aAAa;GACb,SAAS;GACZ,CAAC;EACF,MAAM,MAAM,QAAQ;GAChB,MAAM;GACN,aAAa;GACb,SAAS;GACZ,CAAC;EACL;CAED,OAAgB,WAAW;EACvB;GACI,aAAa;GACb,SAAS;GACZ;EACD;GACI,aAAa;GACb,SAAS;GACZ;EACD;GACI,aAAa;GACb,SAAS;GACZ;EACJ;CAED,MAAa,MAAqB;EAC9B,MAAM,EAAE,UAAU,MAAM,KAAK,MAAM,YAAY;EAE/C,MAAM,MAAM,MAAM,OAAO,iBAAiB,GAAG,QAAQ,KAAK;EAC1D,MAAM,OAAO,MAAM,SAAS,eAAe;AAE3C,OAAK,OAAO,KAAK,oBAAoB,KAAK,KAAK;EAC/C,MAAM,iBAAiB,MAAM,MACzB,YACA,kBAAkB,EAAE,QAAQ,MAAM,QAAQ,CAAC,EAC3C;GACI;GACA,OAAO;GACP,aAAa;GACb,QAAQ;GACX,CACJ;AACD,MAAI,eAAe,OAAQ,MAAK,OAAO,MAAM,YAAY,KAAK,UAAU;MACnE,MAAK,OAAO,QAAQ,YAAY,KAAK,0BAA0B;AACpE,OAAK,OAAO,KAAK;AAEjB,OAAK,OAAO,KAAK,kBAAkB,KAAK,KAAK;EAC7C,MAAM,eAAe,MAAM,MAAM,UAAU,gBAAgB,EAAE,QAAQ,MAAM,QAAQ,CAAC,EAAE;GAClF;GACA,OAAO;GACP,aAAa;GACb,QAAQ;GACX,CAAC;AACF,MAAI,aAAa,OAAQ,MAAK,OAAO,MAAM,UAAU,KAAK,UAAU;MAC/D,MAAK,OAAO,QAAQ,UAAU,KAAK,0BAA0B;AAClE,OAAK,OAAO,KAAK;AAEjB,MAAI,CAAC,eAAe,UAAU,CAAC,aAAa,OACxC,MAAK,OAAO,QAAQ,0CAA0C;OAC3D;AACH,QAAK,OAAO,MAAM,sCAAsC;AACxD,WAAQ,KAAK,EAAE;;;;;;;ACtE3B,MAAa,WAAW,EACpB,MAAM,aACT"}

package/oclif.config.js

@@ -0,0 +1,8 @@
+export default {
+    description: 'Plugin that add the lint command to the jpp cli.',
+    commands: {
+        strategy: 'explicit',
+        target: './dist/index.mjs',
+        identifier: 'commands',
+    },
+};

package/oclif.manifest.json

@@ -0,0 +1,47 @@
+{
+  "commands": {
+    "lint": {
+      "aliases": [],
+      "args": {},
+      "examples": [
+        {
+          "description": "Run the lint command.",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Run the lint command and automatically fix issues.",
+          "command": "<%= config.bin %> <%= command.id %> --format"
+        },
+        {
+          "description": "Run the lint command from the project root directory.",
+          "command": "<%= config.bin %> <%= command.id %> --root"
+        }
+      ],
+      "flags": {
+        "format": {
+          "char": "f",
+          "description": "Automatically fix linting issues.",
+          "name": "format",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "root": {
+          "char": "R",
+          "description": "Lint from the project root directory.",
+          "name": "root",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "lint",
+      "pluginAlias": "@jpp-toolkit/plugin-lint",
+      "pluginName": "@jpp-toolkit/plugin-lint",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Run code linting on the project source code."
+    }
+  },
+  "version": "0.0.11"
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@jpp-toolkit/plugin-lint",
+  "version": "0.0.11",
+  "description": "Plugin that add the lint command to the jpp cli.",
+  "keywords": [
+    "jpp",
+    "plugin",
+    "lint"
+  ],
+  "homepage": "https://github.com/jpapini/jpp-toolkit/tree/main/packages/plugin-lint#readme",
+  "bugs": {
+    "url": "https://github.com/jpapini/jpp-toolkit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jpapini/jpp-toolkit.git",
+    "directory": "packages/plugin-lint"
+  },
+  "license": "MIT",
+  "author": "Julien Papini <julien.papini@gmail.com> (https://github.com/jpapini)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "oclif.config.js",
+    "oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "4.8.0",
+    "execa": "9.6.1",
+    "@jpp-toolkit/core": "0.0.11",
+    "@jpp-toolkit/utils": "0.0.11"
+  },
+  "devDependencies": {
+    "oclif": "4.22.52"
+  },
+  "engines": {
+    "node": "24",
+    "pnpm": "10"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit --pretty",
+    "dev": "build-lib --watch",
+    "build": "build-lib"
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+import { LintCommand } from './lint-command';
+
+export const commands = {
+    lint: LintCommand,
+};

package/src/lint-command.ts

@@ -0,0 +1,76 @@
+import { Command } from '@jpp-toolkit/core';
+import { buildEslintArgs, buildPrettierArgs, findProjectRoot } from '@jpp-toolkit/utils';
+import { Flags } from '@oclif/core';
+import { execa } from 'execa';
+
+export class LintCommand extends Command {
+    static override summary = 'Run code linting on the project source code.';
+
+    static override flags = {
+        format: Flags.boolean({
+            char: 'f',
+            description: 'Automatically fix linting issues.',
+            default: false,
+        }),
+        root: Flags.boolean({
+            char: 'R',
+            description: 'Lint from the project root directory.',
+            default: false,
+        }),
+    };
+
+    static override examples = [
+        {
+            description: 'Run the lint command.',
+            command: '<%= config.bin %> <%= command.id %>',
+        },
+        {
+            description: 'Run the lint command and automatically fix issues.',
+            command: '<%= config.bin %> <%= command.id %> --format',
+        },
+        {
+            description: 'Run the lint command from the project root directory.',
+            command: '<%= config.bin %> <%= command.id %> --root',
+        },
+    ];
+
+    public async run(): Promise<void> {
+        const { flags } = await this.parse(LintCommand);
+
+        const cwd = flags.root ? findProjectRoot() : process.cwd();
+        const mode = flags.format ? 'formatting' : 'linting';
+
+        this.logger.info(`Running Prettier ${mode}...`);
+        const prettierResult = await execa(
+            'prettier',
+            buildPrettierArgs({ format: flags.format }),
+            {
+                cwd,
+                stdio: 'inherit',
+                preferLocal: true,
+                reject: false,
+            },
+        );
+        if (prettierResult.failed) this.logger.error(`Prettier ${mode} failed.`);
+        else this.logger.success(`Prettier ${mode} completed successfully.`);
+        this.logger.log();
+
+        this.logger.info(`Running ESLint ${mode}...`);
+        const eslintResult = await execa('eslint', buildEslintArgs({ format: flags.format }), {
+            cwd,
+            stdio: 'inherit',
+            preferLocal: true,
+            reject: false,
+        });
+        if (eslintResult.failed) this.logger.error(`ESLint ${mode} failed.`);
+        else this.logger.success(`ESLint ${mode} completed successfully.`);
+        this.logger.log();
+
+        if (!prettierResult.failed && !eslintResult.failed) {
+            this.logger.success(`Linting process completed successfully.`);
+        } else {
+            this.logger.error(`Linting process encountered issues.`);
+            process.exit(1);
+        }
+    }
+}