catlint 1.2.1 → 2.0.0

package/dist/cjs/cli/commands/init.d.ts

@@ -0,0 +1 @@
+export declare const init: () => Promise<void>;

package/dist/cjs/cli/commands/lint.d.ts

@@ -0,0 +1 @@
+export declare const lint: () => Promise<void>;

package/dist/cjs/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cjs/config/api/defineConfig.d.ts

@@ -0,0 +1,2 @@
+import type { Config, NormalizedConfig } from '../types/config';
+export declare function defineConfig(config: Config): NormalizedConfig;

package/dist/cjs/config/api/loadConfig.d.ts

@@ -0,0 +1,3 @@
+import type { NormalizedConfig } from '../types/config';
+export declare const loadConfigFromFile: (filePath: string) => Promise<NormalizedConfig | null>;
+export declare const loadConfig: (projectPath: string) => Promise<NormalizedConfig>;

package/dist/cjs/config/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types/config';
+export * from './api/defineConfig';
+export * from './api/loadConfig';

package/dist/cjs/config/types/config.d.ts

@@ -0,0 +1,17 @@
+import type { IRParser } from '../../ir/models/IRParser';
+import type { AdaptedRule, Rule } from '../../rules/models/rule/model';
+export interface Config {
+    lint: {
+        includes: string[];
+        excludes: string[];
+    };
+    parsers: {
+        pattern: string;
+        parser: IRParser;
+    }[];
+    rules: Rule[];
+}
+export interface NormalizedConfig extends Config {
+    rules: AdaptedRule[];
+}
+export declare const defaultConfig: NormalizedConfig;

package/dist/cjs/config/types/configAdapter.d.ts

@@ -0,0 +1,2 @@
+import type { Config, NormalizedConfig } from './config';
+export declare const adaptConfig: (c: Config) => NormalizedConfig;

package/dist/cjs/core/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './linter';
+export * from './lintProject';
+export * from './linter';

package/dist/cjs/core/api/lintProject.d.ts

@@ -0,0 +1,2 @@
+import type { NormalizedConfig } from '../../config/types/config';
+export declare const lintProject: (config: NormalizedConfig, projectDir: string) => Promise<import("..").LintResult[][]>;

package/dist/cjs/core/api/linter.d.ts

@@ -0,0 +1,5 @@
+import type { LintResult } from '../models/lintResult/model';
+import type { IRFile } from '../../ir/models/File';
+import type { AdaptedRule } from '../../rules/models/rule/model';
+export declare function travelFile(file: IRFile): (rule: AdaptedRule) => LintResult;
+export declare function lintFile(file: IRFile, rules: AdaptedRule[]): LintResult[];

package/dist/cjs/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './api';

package/dist/cjs/core/models/index.d.ts

@@ -0,0 +1 @@
+export * from './lintResult';

package/dist/cjs/core/models/lintResult/index.d.ts

@@ -0,0 +1 @@
+export * from './model';

package/dist/cjs/core/models/lintResult/model.d.ts

@@ -0,0 +1,7 @@
+import type { Message } from '../../../rules/models/message/model';
+export type LintResult = {
+    name: string;
+    messages: Message[];
+    subrules: LintResult[];
+    isCorrect: boolean;
+};

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './core';
+export * from './ir';
+export * from './rules';

package/dist/cjs/ir/index.d.ts

@@ -0,0 +1 @@
+export * from './models';

package/dist/cjs/ir/models/File.d.ts

@@ -0,0 +1,6 @@
+import type { IRNode } from './Node';
+export interface IRFile {
+    name: string;
+    extensions: string[];
+    program: IRNode[];
+}

package/dist/cjs/ir/models/IRParser.d.ts

@@ -0,0 +1,2 @@
+import type { IRFile } from './File';
+export type IRParser = (filename: string, content: string) => IRFile;

package/dist/cjs/ir/models/Node.d.ts

@@ -0,0 +1,13 @@
+export declare enum IRKind {
+    Codeline = 0,
+    Literal = 1,
+    Function = 2,
+    Class = 3,
+    Variable = 4
+}
+export interface IRNode {
+    line: number;
+    kind: IRKind;
+    name: string;
+    value: IRNode[];
+}

package/dist/cjs/ir/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './File';
+export * from './IRParser';
+export * from './Node';

package/dist/cjs/rules/helpers/defaultAdapter.d.ts

@@ -0,0 +1,9 @@
+import type { AdaptedRule, Rule } from '../models/rule/model';
+/**
+ * @function defaultAdapter recursively adapts a Rule to an AdaptedRule by providing default values for undefined/null fields.
+ *
+ * @param rule the rule to adapt
+ * @returns a AdaptedRule without undefined/null fields
+ *
+ */
+export declare const defaultAdapter: (rule: Rule) => AdaptedRule;

package/dist/cjs/rules/index.d.ts

@@ -0,0 +1 @@
+export * from './models';

package/dist/cjs/rules/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './rule';
+export * from './message';

package/dist/cjs/rules/models/message/index.d.ts

@@ -0,0 +1 @@
+export * from './model';

package/dist/cjs/rules/models/message/model.d.ts

@@ -0,0 +1,10 @@
+export declare enum Level {
+    Error = "ERROR",
+    Warning = "WARNING",
+    Info = "INFO"
+}
+export interface Message {
+    message: string;
+    line: number;
+    level: Level;
+}

package/dist/cjs/rules/models/rule/index.d.ts

@@ -0,0 +1,2 @@
+export * from './model';
+export * from './service';

package/dist/cjs/rules/models/rule/model.d.ts

@@ -0,0 +1,12 @@
+import type { IRFile } from '../../../ir/models/File';
+import type { Message } from '../../models/message/model';
+export type RuleFn = (file: IRFile) => Message[];
+export interface Rule {
+    name: string;
+    fn?: RuleFn;
+    subrules?: Rule[];
+}
+export interface AdaptedRule extends Rule {
+    fn: RuleFn;
+    subrules: AdaptedRule[];
+}

package/dist/cjs/rules/models/rule/service.d.ts

@@ -0,0 +1,2 @@
+import type { Rule, RuleFn } from './model';
+export declare const createRule: (name: string, fn: (subrule: (subrule: Rule) => void) => RuleFn) => Rule;

package/dist/cjs/shared/pattern/loadFiles.d.ts

@@ -0,0 +1 @@
+export declare const loadFiles: (baseDir: string, includes: string[], excludes?: string[]) => Promise<string[]>;

package/dist/esm/cli/commands/init.d.ts

@@ -0,0 +1 @@
+export declare const init: () => Promise<void>;

package/dist/esm/cli/commands/init.js

@@ -0,0 +1,18 @@
+import inquirer from 'inquirer';
+import * as fs from 'fs';
+import { defaultConfig } from '../../config/index';
+import { inspect } from 'util';
+export const init = async () => {
+    const { useTypescript } = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'useTypescript',
+            message: 'Do you want to use typescript?',
+            default: true,
+        },
+    ]);
+    fs.writeFileSync(`catlint.config.${useTypescript ? 'ts' : 'js'}`, `import { defineConfig } from 'catlint/config';
+
+export default defineConfig(${inspect(defaultConfig)});
+`);
+};

package/dist/esm/cli/commands/lint.d.ts

@@ -0,0 +1 @@
+export declare const lint: () => Promise<void>;

package/dist/esm/cli/commands/lint.js

@@ -0,0 +1,6 @@
+import { defaultConfig, loadConfig } from '../../config/index';
+import { lintProject } from '../../core/api/lintProject';
+export const lint = async () => {
+    const config = (await loadConfig('.')) ?? defaultConfig;
+    lintProject(config, '.');
+};

package/dist/esm/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/esm/cli/index.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { init } from './commands/init';
+import { lint } from './commands/lint';
+const program = new Command();
+program.name('catlint').description('A linter for detecting code bad practices').version('0.0.1');
+program
+    .command('init')
+    .description('Inits CatLint in your current project folder')
+    .action(async () => await init());
+program
+    .command('lint')
+    .description('Lints the current project')
+    .action(async () => await lint());
+program.parse();

package/dist/esm/config/api/defineConfig.d.ts

@@ -0,0 +1,2 @@
+import type { Config, NormalizedConfig } from '../types/config';
+export declare function defineConfig(config: Config): NormalizedConfig;

package/dist/esm/config/api/defineConfig.js

@@ -0,0 +1,8 @@
+import { defaultAdapter } from '../../rules/helpers/defaultAdapter';
+export function defineConfig(config) {
+    const normalizedConfig = {
+        ...config,
+        rules: config.rules.map((rule) => defaultAdapter(rule)),
+    };
+    return normalizedConfig;
+}

package/dist/esm/config/api/loadConfig.d.ts

@@ -0,0 +1,3 @@
+import type { NormalizedConfig } from '../types/config';
+export declare const loadConfigFromFile: (filePath: string) => Promise<NormalizedConfig | null>;
+export declare const loadConfig: (projectPath: string) => Promise<NormalizedConfig>;

package/dist/esm/config/api/loadConfig.js

@@ -0,0 +1,22 @@
+import { adaptConfig } from '../types/configAdapter';
+import * as path from 'path';
+import { pathToFileURL } from 'url';
+export const loadConfigFromFile = async (filePath) => {
+    try {
+        const config = await import(pathToFileURL(filePath).href);
+        return adaptConfig(config.default);
+    }
+    catch {
+        console.log(`No config file found at ${filePath}`);
+        return null;
+    }
+};
+export const loadConfig = async (projectPath) => {
+    const configPath = path.join(process.cwd(), projectPath) + '/catlint.config';
+    const config = (await loadConfigFromFile(configPath + '.js')) ??
+        (await loadConfigFromFile(configPath + '.ts'));
+    if (!config) {
+        throw new Error('No config file found');
+    }
+    return config;
+};

package/dist/esm/config/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types/config';
+export * from './api/defineConfig';
+export * from './api/loadConfig';

package/dist/esm/config/index.js

@@ -0,0 +1,3 @@
+export * from './types/config';
+export * from './api/defineConfig';
+export * from './api/loadConfig';

package/dist/esm/config/types/config.d.ts

@@ -0,0 +1,17 @@
+import type { IRParser } from '../../ir/models/IRParser';
+import type { AdaptedRule, Rule } from '../../rules/models/rule/model';
+export interface Config {
+    lint: {
+        includes: string[];
+        excludes: string[];
+    };
+    parsers: {
+        pattern: string;
+        parser: IRParser;
+    }[];
+    rules: Rule[];
+}
+export interface NormalizedConfig extends Config {
+    rules: AdaptedRule[];
+}
+export declare const defaultConfig: NormalizedConfig;

package/dist/esm/config/types/config.js

@@ -0,0 +1,8 @@
+export const defaultConfig = {
+    lint: {
+        includes: ['**/*.ts'],
+        excludes: ['node_modules/**'],
+    },
+    parsers: [],
+    rules: [],
+};

package/dist/esm/config/types/configAdapter.d.ts

@@ -0,0 +1,2 @@
+import type { Config, NormalizedConfig } from './config';
+export declare const adaptConfig: (c: Config) => NormalizedConfig;

package/dist/esm/config/types/configAdapter.js

@@ -0,0 +1,8 @@
+import { defaultAdapter } from '../../rules/helpers/defaultAdapter';
+export const adaptConfig = (config) => {
+    const normalizedConfig = {
+        ...config,
+        rules: config.rules.map((rule) => defaultAdapter(rule)),
+    };
+    return normalizedConfig;
+};

package/dist/esm/core/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './linter';
+export * from './lintProject';
+export * from './linter';

package/dist/esm/core/api/index.js

@@ -0,0 +1,3 @@
+export * from './linter';
+export * from './lintProject';
+export * from './linter';

package/dist/esm/core/api/lintProject.d.ts

@@ -0,0 +1,2 @@
+import type { NormalizedConfig } from '../../config/types/config';
+export declare const lintProject: (config: NormalizedConfig, projectDir: string) => Promise<import("..").LintResult[][]>;

package/dist/esm/core/api/lintProject.js

@@ -0,0 +1,16 @@
+import { loadFiles } from '../../shared/pattern/loadFiles';
+import { lintFile } from './linter';
+import * as fs from 'fs';
+import { Minimatch } from 'minimatch';
+export const lintProject = async (config, projectDir) => {
+    const files = await loadFiles(projectDir, config.lint.includes, config.lint.excludes);
+    return files
+        .map((filePath) => {
+        const fileContent = fs.readFileSync(filePath, 'utf-8');
+        const parser = config.parsers.find((parser) => new Minimatch(parser.pattern).match(filePath));
+        if (!parser)
+            console.error(`No parser found for file ${filePath}`);
+        return parser?.parser(fileContent, filePath) ?? {};
+    })
+        .map((file) => lintFile(file, config.rules));
+};

package/dist/esm/core/api/linter.d.ts

@@ -0,0 +1,5 @@
+import type { LintResult } from '../models/lintResult/model';
+import type { IRFile } from '../../ir/models/File';
+import type { AdaptedRule } from '../../rules/models/rule/model';
+export declare function travelFile(file: IRFile): (rule: AdaptedRule) => LintResult;
+export declare function lintFile(file: IRFile, rules: AdaptedRule[]): LintResult[];

package/dist/esm/core/api/linter.js

@@ -0,0 +1,15 @@
+export function travelFile(file) {
+    const travelRule = (rule) => {
+        return {
+            name: rule.name,
+            messages: rule.fn(file),
+            subrules: rule.subrules.map(travelRule),
+            isCorrect: rule.fn(file).length === 0 && rule.subrules.every((r) => travelRule(r).isCorrect),
+        };
+    };
+    return travelRule;
+}
+export function lintFile(file, rules) {
+    const results = rules.map((rule) => travelFile(file)(rule));
+    return results;
+}

package/dist/esm/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './api';

package/dist/esm/core/index.js

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './api';

package/dist/esm/core/models/index.d.ts

@@ -0,0 +1 @@
+export * from './lintResult';

package/dist/esm/core/models/index.js

@@ -0,0 +1 @@
+export * from './lintResult';

package/dist/esm/core/models/lintResult/index.d.ts

@@ -0,0 +1 @@
+export * from './model';

package/dist/esm/core/models/lintResult/index.js

@@ -0,0 +1 @@
+export * from './model';

package/dist/esm/core/models/lintResult/model.d.ts

@@ -0,0 +1,7 @@
+import type { Message } from '../../../rules/models/message/model';
+export type LintResult = {
+    name: string;
+    messages: Message[];
+    subrules: LintResult[];
+    isCorrect: boolean;
+};

package/dist/esm/core/models/lintResult/model.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './core';
+export * from './ir';
+export * from './rules';

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './core';
+export * from './ir';
+export * from './rules';

package/dist/esm/ir/index.d.ts

@@ -0,0 +1 @@
+export * from './models';

package/dist/esm/ir/index.js

@@ -0,0 +1 @@
+export * from './models';

package/dist/esm/ir/models/File.d.ts

@@ -0,0 +1,6 @@
+import type { IRNode } from './Node';
+export interface IRFile {
+    name: string;
+    extensions: string[];
+    program: IRNode[];
+}

package/dist/esm/ir/models/File.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/ir/models/IRParser.d.ts

@@ -0,0 +1,2 @@
+import type { IRFile } from './File';
+export type IRParser = (filename: string, content: string) => IRFile;

package/dist/esm/ir/models/IRParser.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/ir/models/Node.d.ts

@@ -0,0 +1,13 @@
+export declare enum IRKind {
+    Codeline = 0,
+    Literal = 1,
+    Function = 2,
+    Class = 3,
+    Variable = 4
+}
+export interface IRNode {
+    line: number;
+    kind: IRKind;
+    name: string;
+    value: IRNode[];
+}

package/dist/esm/ir/models/Node.js

@@ -0,0 +1,8 @@
+export var IRKind;
+(function (IRKind) {
+    IRKind[IRKind["Codeline"] = 0] = "Codeline";
+    IRKind[IRKind["Literal"] = 1] = "Literal";
+    IRKind[IRKind["Function"] = 2] = "Function";
+    IRKind[IRKind["Class"] = 3] = "Class";
+    IRKind[IRKind["Variable"] = 4] = "Variable";
+})(IRKind || (IRKind = {}));

package/dist/esm/ir/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './File';
+export * from './IRParser';
+export * from './Node';

package/dist/esm/ir/models/index.js

@@ -0,0 +1,3 @@
+export * from './File';
+export * from './IRParser';
+export * from './Node';

package/dist/esm/rules/helpers/defaultAdapter.d.ts

@@ -0,0 +1,9 @@
+import type { AdaptedRule, Rule } from '../models/rule/model';
+/**
+ * @function defaultAdapter recursively adapts a Rule to an AdaptedRule by providing default values for undefined/null fields.
+ *
+ * @param rule the rule to adapt
+ * @returns a AdaptedRule without undefined/null fields
+ *
+ */
+export declare const defaultAdapter: (rule: Rule) => AdaptedRule;

package/dist/esm/rules/helpers/defaultAdapter.js

@@ -0,0 +1,16 @@
+const EMPTY_FN = () => [];
+/**
+ * @function defaultAdapter recursively adapts a Rule to an AdaptedRule by providing default values for undefined/null fields.
+ *
+ * @param rule the rule to adapt
+ * @returns a AdaptedRule without undefined/null fields
+ *
+ */
+export const defaultAdapter = (rule) => {
+    const { name, fn = EMPTY_FN, subrules = [] } = rule;
+    return {
+        name,
+        fn,
+        subrules: subrules.map(defaultAdapter),
+    };
+};

package/dist/esm/rules/index.d.ts

@@ -0,0 +1 @@
+export * from './models';

package/dist/esm/rules/index.js

@@ -0,0 +1 @@
+export * from './models';

package/dist/esm/rules/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './rule';
+export * from './message';

package/dist/esm/rules/models/index.js

@@ -0,0 +1,2 @@
+export * from './rule';
+export * from './message';

package/dist/esm/rules/models/message/index.d.ts

@@ -0,0 +1 @@
+export * from './model';

package/dist/esm/rules/models/message/index.js

@@ -0,0 +1 @@
+export * from './model';

package/dist/esm/rules/models/message/model.d.ts

@@ -0,0 +1,10 @@
+export declare enum Level {
+    Error = "ERROR",
+    Warning = "WARNING",
+    Info = "INFO"
+}
+export interface Message {
+    message: string;
+    line: number;
+    level: Level;
+}

package/dist/esm/rules/models/message/model.js

@@ -0,0 +1,6 @@
+export var Level;
+(function (Level) {
+    Level["Error"] = "ERROR";
+    Level["Warning"] = "WARNING";
+    Level["Info"] = "INFO";
+})(Level || (Level = {}));

package/dist/esm/rules/models/rule/index.d.ts

@@ -0,0 +1,2 @@
+export * from './model';
+export * from './service';

package/dist/esm/rules/models/rule/index.js

@@ -0,0 +1,2 @@
+export * from './model';
+export * from './service';

package/dist/esm/rules/models/rule/model.d.ts

@@ -0,0 +1,12 @@
+import type { IRFile } from '../../../ir/models/File';
+import type { Message } from '../../models/message/model';
+export type RuleFn = (file: IRFile) => Message[];
+export interface Rule {
+    name: string;
+    fn?: RuleFn;
+    subrules?: Rule[];
+}
+export interface AdaptedRule extends Rule {
+    fn: RuleFn;
+    subrules: AdaptedRule[];
+}

package/dist/esm/rules/models/rule/model.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/rules/models/rule/service.d.ts

@@ -0,0 +1,2 @@
+import type { Rule, RuleFn } from './model';
+export declare const createRule: (name: string, fn: (subrule: (subrule: Rule) => void) => RuleFn) => Rule;

package/dist/esm/rules/models/rule/service.js

@@ -0,0 +1,9 @@
+export const createRule = (name, fn) => {
+    const subrules = [];
+    const ruleFn = fn((subrule) => subrules.push(subrule));
+    return {
+        name,
+        fn: ruleFn,
+        subrules,
+    };
+};

package/dist/esm/shared/pattern/loadFiles.d.ts

@@ -0,0 +1 @@
+export declare const loadFiles: (baseDir: string, includes: string[], excludes?: string[]) => Promise<string[]>;

package/dist/esm/shared/pattern/loadFiles.js

@@ -0,0 +1,6 @@
+import { glob } from 'glob';
+export const loadFiles = async (baseDir, includes, excludes = []) => {
+    const included = (await Promise.all(includes.map((pattern) => glob(pattern, { cwd: baseDir, absolute: true })))).flat();
+    const excluded = (await Promise.all(excludes.map((pattern) => glob(pattern, { cwd: baseDir, absolute: true })))).flat();
+    return included.filter((file) => !excluded.includes(file));
+};