ko-lints 1.0.0-alpha.1 → 2.0.0

package/README.md

@@ -1,5 +1,3 @@
 # ko-lint
 
-This package is a lint cli used by [ko](https://github.com/DTStack/ko)
-
-## Usage Outside of ko
+This package is used by [ko](https://github.com/DTStack/ko)

package/index.d.ts

@@ -1,3 +1,19 @@
-import { Command } from 'commander';
+import { Pattern } from 'fast-glob';
 
-export default function initKoLintCli(p: Command): void
+export type IOpts = {
+  write: boolean;
+  configPath: string;
+  patterns: Pattern[];
+};
+
+export type IKeys = 'eslint' | 'prettier' | 'stylelint';
+
+declare class Lints {
+  private runner;
+  private opts;
+  state: 0 | 1;
+  constructor(opts: IOpts);
+  run(key: IKeys): Promise<true | string[]>;
+}
+
+export default Lints;

package/lib/eslint.js

@@ -1 +1,70 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ko_lint_config_1 = require("ko-lint-config");
+const factory_1 = __importDefault(require("./factory"));
+const { ESLint } = ko_lint_config_1.eslint;
+class ESlintRunner extends factory_1.default {
+    constructor(opts) {
+        super();
+        this.stdout = [];
+        this.opts = opts;
+        this.generateConfig();
+    }
+    generateConfig() {
+        if (this.opts.configPath) {
+            this.config = this.getConfigFromFile(this.opts.configPath);
+        }
+        else {
+            const localConfigPath = this.detectLocalRunnerConfig('eslint');
+            if (localConfigPath) {
+                this.config = this.getConfigFromFile(localConfigPath);
+            }
+        }
+    }
+    async start() {
+        const { write, patterns } = this.opts;
+        const entries = await this.getEntries(patterns, [
+            ...ESlintRunner.IGNORE_FILES,
+        ]);
+        if (entries.length === 0) {
+            console.log(`No files matched with pattern:${patterns} via ${ESlintRunner.NAME}`);
+            process.exit(0);
+        }
+        const eslintInstance = new ESLint({
+            fix: write,
+            overrideConfig: this.config,
+            useEslintrc: false,
+            extensions: ESlintRunner.EXTENSIONS,
+        });
+        try {
+            const formatter = await eslintInstance.loadFormatter();
+            const eslintFilesPromises = entries.map(async (file) => {
+                const result = await eslintInstance.lintFiles(file);
+                if (result[0].errorCount) {
+                    const resultText = formatter.format(result);
+                    this.stdout.push(resultText);
+                    return false;
+                }
+                return true;
+            });
+            const result = await Promise.all(eslintFilesPromises);
+            if (result.includes(false)) {
+                return this.stdout;
+            }
+            else {
+                return true;
+            }
+        }
+        catch (ex) {
+            console.error(ex);
+            process.exit(1);
+        }
+    }
+}
+ESlintRunner.EXTENSIONS = ['ts', 'tsx', 'js', 'jsx'];
+ESlintRunner.IGNORE_FILES = ['.eslintignore'];
+ESlintRunner.NAME = 'eslint';
+exports.default = ESlintRunner;

package/lib/factory.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const fs_1 = require("fs");
+const assert_1 = __importDefault(require("assert"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
+class LintRunnerFactory {
+    constructor() {
+        this.cwd = process.cwd();
+    }
+    async getEntries(patterns, ignoreFiles) {
+        return (0, fast_glob_1.default)(patterns, {
+            dot: true,
+            ignore: this.getIgnorePatterns(...ignoreFiles),
+        });
+    }
+    getIgnorePatterns(...ignoreFiles) {
+        return ['.gitignore', ...ignoreFiles]
+            .map(fileName => {
+            const filePath = (0, path_1.join)(this.cwd, fileName);
+            if ((0, fs_1.existsSync)(filePath)) {
+                return (0, fs_1.readFileSync)(filePath, 'utf-8')
+                    .split('\n')
+                    .filter(str => str && !str.startsWith('#'));
+            }
+            return [];
+        })
+            .reduce((acc, current) => {
+            current.forEach(p => {
+                if (!acc.includes(p)) {
+                    acc.push(p);
+                }
+            });
+            return acc;
+        }, []);
+    }
+    getConfigFromFile(filepath) {
+        (0, assert_1.default)((0, path_1.isAbsolute)(filepath), 'only accept absolute config filepath');
+        return require(filepath);
+    }
+    detectLocalRunnerConfig(name) {
+        const cwd = process.cwd();
+        const files = (0, fs_1.readdirSync)(cwd).filter(path => !(0, fs_1.statSync)(path).isDirectory());
+        let ret = '';
+        for (let file of files) {
+            if (file.includes(name) && !file.includes('ignore')) {
+                ret = file;
+                break;
+            }
+        }
+        return ret ? (0, path_1.join)(cwd, ret) : ret;
+    }
+}
+exports.default = LintRunnerFactory;

package/lib/index.js

@@ -1,27 +1,30 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("./constants");
-const utils_1 = require("./utils");
-const prettier_1 = require("./prettier");
-function initKoLintCli(program) {
-    program
-        .command('prettier [patterns]')
-        .alias('pr')
-        .description('use prettier to format your codes')
-        .option('-w, --write', 'Edit files in-place. (Beware!)')
-        .option('-c, --config <configPath>', 'set prettier config path')
-        .action((patterns = constants_1.defaultPatterns, opts) => {
-        const { write, configPath } = opts;
-        const targetFiles = utils_1.getTargetFiles(patterns);
-        prettier_1.formatFilesWithPrettier(targetFiles, !write, configPath);
-    });
-    program
-        .command('eslint [patterns]')
-        .alias('es')
-        .description('use eslint to format your codes')
-        .option('-c, --config <path>', 'set eslint config path')
-        .action((patterns = constants_1.defaultPatterns, ops) => {
-        //TODO
-    });
+const eslint_1 = __importDefault(require("./eslint"));
+const prettier_1 = __importDefault(require("./prettier"));
+const stylelint_1 = __importDefault(require("./stylelint"));
+class Lints {
+    constructor(opts) {
+        this.opts = opts;
+    }
+    async run(key) {
+        switch (key) {
+            case 'eslint':
+                this.runner = new eslint_1.default(this.opts);
+                break;
+            case 'prettier':
+                this.runner = new prettier_1.default(this.opts);
+                break;
+            case 'stylelint':
+                this.runner = new stylelint_1.default(this.opts);
+                break;
+        }
+        this.runner.generateConfig();
+        const result = await this.runner.start();
+        return result;
+    }
 }
-exports.default = initKoLintCli;
+exports.default = Lints;

package/lib/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/prettier.js

@@ -1,48 +1,73 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatFilesWithPrettier = void 0;
-const fs_1 = require("fs");
-const prettier_1 = require("prettier");
-const utils_1 = require("./utils");
-async function formatFilesWithPrettier(files, isCheck, configPath) {
-    const prettierConfig = configPath
-        ? require(utils_1.findRealPath(configPath))
-        : require('ko-config/prettier');
-    console.log('prettier process starting...');
-    const formatFilesPromises = files.map(async (file) => {
-        try {
-            const source = await fs_1.promises.readFile(file, 'utf-8');
-            const opts = { ...prettierConfig, filepath: file };
-            if (isCheck) {
-                return prettier_1.check(source, opts);
-            }
-            else {
-                const formatContent = prettier_1.format(source, opts);
-                return fs_1.promises.writeFile(file, formatContent, 'utf-8');
+const promises_1 = require("fs/promises");
+const ko_lint_config_1 = require("ko-lint-config");
+const factory_1 = __importDefault(require("./factory"));
+const { format, check } = ko_lint_config_1.prettier;
+class PrettierRunner extends factory_1.default {
+    constructor(opts) {
+        super();
+        this.stdout = [];
+        this.opts = opts;
+        this.generateConfig();
+    }
+    generateConfig() {
+        if (this.opts.configPath) {
+            this.config = this.getConfigFromFile(this.opts.configPath);
+        }
+        else {
+            const localConfigPath = this.detectLocalRunnerConfig('prettier');
+            if (localConfigPath) {
+                this.config = this.getConfigFromFile(localConfigPath);
             }
         }
-        catch (ex) {
-            throw ex;
+    }
+    async start() {
+        const { write, patterns } = this.opts;
+        const entries = await this.getEntries(patterns, [
+            ...PrettierRunner.IGNORE_FILES,
+        ]);
+        if (entries.length === 0) {
+            console.log(`No files matched with pattern:${patterns} via ${PrettierRunner.NAME}`);
+            process.exit(0);
         }
-    });
-    try {
-        let stdout = '';
-        const result = await Promise.all(formatFilesPromises);
-        if (isCheck) {
+        try {
+            const formatFilesPromises = entries.map(async (file) => {
+                const source = await (0, promises_1.readFile)(file, 'utf-8');
+                const opts = { ...this.config, filepath: file };
+                if (write) {
+                    const formatContent = format(source, opts);
+                    await (0, promises_1.writeFile)(file, formatContent, 'utf-8');
+                    return true;
+                }
+                else {
+                    if (check(source, opts)) {
+                        return true;
+                    }
+                    else {
+                        this.stdout.push(`file ${opts.filepath} doesn't match prettier config`);
+                        return false;
+                    }
+                }
+            });
+            const result = await Promise.all(formatFilesPromises);
             if (result.includes(false)) {
-                stdout = 'Not all matched files are formatted';
+                return this.stdout;
             }
             else {
-                stdout = 'All matched files are formatted';
+                return true;
             }
         }
-        else {
-            stdout = 'All matched files are rewrited successfully!';
+        catch (ex) {
+            console.error(ex);
+            process.exit(1);
         }
-        console.log(stdout);
-    }
-    catch (ex) {
-        console.error('prettier failed:', ex);
     }
 }
-exports.formatFilesWithPrettier = formatFilesWithPrettier;
+PrettierRunner.EXTENSIONS = ['ts', 'tsx', 'js', 'jsx', 'json'];
+PrettierRunner.IGNORE_FILES = ['.prettierignore'];
+PrettierRunner.NAME = 'prettier';
+exports.default = PrettierRunner;

package/lib/stylelint.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ko_lint_config_1 = require("ko-lint-config");
+const factory_1 = __importDefault(require("./factory"));
+const { lint, formatters } = ko_lint_config_1.stylelint;
+class StyleLintRunner extends factory_1.default {
+    constructor(opts) {
+        super();
+        this.stdout = [];
+        this.opts = opts;
+        this.generateConfig();
+    }
+    generateConfig() {
+        if (this.opts.configPath) {
+            this.config = this.getConfigFromFile(this.opts.configPath);
+        }
+        else {
+            const localConfigPath = this.detectLocalRunnerConfig(StyleLintRunner.NAME);
+            if (localConfigPath) {
+                this.config = this.getConfigFromFile(localConfigPath);
+            }
+        }
+    }
+    async start() {
+        const { write, patterns } = this.opts;
+        const entries = await this.getEntries(patterns, [
+            ...StyleLintRunner.IGNORE_FILES,
+        ]);
+        if (entries.length === 0) {
+            console.log(`No files matched with pattern:${patterns} via ${StyleLintRunner.NAME}`);
+            process.exit(0);
+        }
+        try {
+            const result = await lint({
+                fix: write,
+                config: this.config,
+                files: entries,
+            });
+            if (result.errored) {
+                this.stdout = [formatters.string(result.results)];
+                return this.stdout;
+            }
+            else {
+                return true;
+            }
+        }
+        catch (ex) {
+            console.error(ex);
+            process.exit(1);
+        }
+    }
+}
+StyleLintRunner.EXTENSIONS = ['css', 'less', 'sass', 'scss'];
+StyleLintRunner.IGNORE_FILES = ['.stylelintignore'];
+StyleLintRunner.NAME = 'stylelint';
+exports.default = StyleLintRunner;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ko-lints",
-  "version": "1.0.0-alpha.1",
+  "version": "2.0.0",
   "description": "lint tools used by ko",
   "keywords": [
     "ko",
@@ -16,31 +16,28 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/DTStack/ko",
-    "directory": "packages/ko-lint"
+    "directory": "packages/ko-lints"
   },
   "license": "MIT",
-  "main": "./lib/index.js",
-  "typings": "./index.d.ts",
-  "bin": {
-    "ko-lint": "./lib/cli.js"
-  },
+  "typings": "index.d.ts",
+  "main": "lib/index.js",
   "files": [
     "lib/*",
     "index.d.ts"
   ],
-  "scripts": {
-    "prepublishOnly": "tsc",
-    "build": "tsc",
-    "debug": "tsc --sourcemap -w"
-  },
   "dependencies": {
-    "@types/prettier": "^2.3.2",
-    "commander": "^8.1.0",
-    "fast-glob": "^3.2.7",
-    "ko-config": "^1.0.0-alpha.1"
+    "fast-glob": "^3.2.11"
+  },
+  "peerDependencies": {
+    "ko-lint-config": "1.0.0"
   },
   "devDependencies": {
-    "typescript": "^4.3.5"
+    "typescript": "^4.6.4",
+    "ko-lint-config": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "debug": "tsc --sourcemap -w"
   },
-  "gitHead": "ba7647fc680c8812d07374e234c0bee0e4cae6fd"
-}
+  "readme": "# ko-lint\n\nThis package is used by [ko](https://github.com/DTStack/ko)\n"
+}

package/lib/cli.js

@@ -1,13 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const index_1 = __importDefault(require("./index"));
-const pkg = require('../package.json');
-const program = new commander_1.Command();
-program.description('ko lint tools').version(pkg.version, '-v --version');
-index_1.default(program);
-program.parse();

package/lib/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultPatterns = exports.defaultIgnoreFile = void 0;
-exports.defaultIgnoreFile = '.koignore';
-exports.defaultPatterns = '*';

package/lib/utils.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTargetFiles = exports.findRealPath = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const fast_glob_1 = require("fast-glob");
-const constants_1 = require("./constants");
-function findRealPath(configPath) {
-    if (!fs_1.realpathSync(configPath)) {
-        configPath = path_1.join(process.cwd(), configPath);
-    }
-    if (fs_1.existsSync(configPath)) {
-        return configPath;
-    }
-    throw new Error('config file is not exist, please checkout config file path!');
-}
-exports.findRealPath = findRealPath;
-/**
- * @link Pattern syntax: https://github.com/mrmlnc/fast-glob#pattern-syntax
- */
-function getTargetFiles(patterns, ignoreFile) {
-    if (!ignoreFile) {
-        ignoreFile = path_1.join(process.cwd(), constants_1.defaultIgnoreFile);
-    }
-    return fast_glob_1.sync(patterns, {
-        ignore: getIgnorePatterns(ignoreFile),
-    });
-}
-exports.getTargetFiles = getTargetFiles;
-function getIgnorePatterns(ignoreFile) {
-    const gitIgnorePath = path_1.join(process.cwd(), '.gitignore');
-    const gitIgnorePatterns = getFilePatterns(gitIgnorePath);
-    const ignorePatterns = getFilePatterns(ignoreFile);
-    return ignorePatterns.reduce((accumlator, currentValue) => {
-        if (!accumlator.includes(currentValue)) {
-            accumlator.push(currentValue);
-        }
-        return accumlator;
-    }, gitIgnorePatterns);
-}
-function getFilePatterns(filePath) {
-    let patterns = [];
-    if (fs_1.existsSync(filePath)) {
-        patterns = fs_1.readFileSync(filePath, 'utf-8').split('\n');
-    }
-    return patterns;
-}