@teambit/oxc.linter.oxlint-node 0.0.1

package/dist/fixes.d.ts

@@ -0,0 +1,12 @@
+export type FixesFlags = Partial<{
+    all: boolean;
+    suggestions: boolean;
+    dangerously: boolean;
+}>;
+export type FixType = keyof FixesFlags;
+export declare class Fixes {
+    flags: FixesFlags;
+    constructor(flags: FixesFlags);
+    toCliArgs(): string[];
+    static from(flags: FixesFlags): Fixes;
+}

package/dist/fixes.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fixes = void 0;
+class Fixes {
+    constructor(flags) {
+        this.flags = flags;
+    }
+    toCliArgs() {
+        return Object.keys(this.flags).reduce((acc, key) => {
+            if (this.flags[key]) {
+                if (key === 'all') {
+                    acc.push('--fix');
+                }
+                else {
+                    acc.push(`--fix-${key}`);
+                }
+            }
+            return acc;
+        }, []);
+    }
+    static from(flags) {
+        return new Fixes(flags);
+    }
+}
+exports.Fixes = Fixes;
+//# sourceMappingURL=fixes.js.map

package/dist/fixes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixes.js","sourceRoot":"","sources":["../fixes.ts"],"names":[],"mappings":";;;AAQA,MAAa,KAAK;IAChB,YAAmB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAExC,SAAS;QACP,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAc,CAAC,EAAE,CAAC;gBAC/B,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;oBAClB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC;qBAAM,CAAC;oBACN,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAc,CAAC,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAiB;QAC3B,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF;AAnBD,sBAmBC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { OxlintNode } from './oxlint-node';
+export type { OxlintNodeOptions } from './options';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OxlintNode = void 0;
+var oxlint_node_1 = require("./oxlint-node");
+Object.defineProperty(exports, "OxlintNode", { enumerable: true, get: function () { return oxlint_node_1.OxlintNode; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,6CAA2C;AAAlC,yGAAA,UAAU,OAAA"}

package/dist/options.d.ts

@@ -0,0 +1,34 @@
+import { FixesFlags } from './fixes';
+import { PluginsFlags } from './plugins';
+import { RulesFlags } from './rules';
+export type OxlintFormat = 'default' | 'json' | 'unix' | 'checkstyle' | 'github';
+export type OxlintNodeOptions = {
+    /**
+     * path to oxlint config file to use during linting
+     */
+    configPath?: string;
+    /**
+     * path to tsconfig to use during compilation.
+     */
+    tsconfigPath?: string;
+    /**
+     * decide the format for the CLI output.
+     */
+    formats?: OxlintFormat[];
+    /**
+     * decide the plugins to enable.
+     */
+    pluginsFlags?: PluginsFlags;
+    /**
+     * decide the rules / categories to enable.
+     */
+    rulesFlags?: RulesFlags;
+    /**
+     * decide the fixes to enable.
+     */
+    fixesFlags?: FixesFlags;
+    /**
+     * path to oxlint binary.
+     */
+    binPath?: any;
+};

package/dist/options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../options.ts"],"names":[],"mappings":""}

package/dist/oxlint-node.d.ts

@@ -0,0 +1,22 @@
+import { OxlintFormat, OxlintNodeOptions } from './options';
+import { Plugins } from './plugins';
+import { Rules } from './rules';
+import { Fixes } from './fixes';
+export type OxlintMultiFormatResult = Partial<Record<OxlintFormat, any>>;
+export declare class OxlintNode {
+    binPath: string;
+    plugins: Plugins;
+    rules: Rules;
+    fixes: Fixes;
+    formats: OxlintFormat[];
+    configPath?: string | undefined;
+    tsconfigPath?: string | undefined;
+    constructor(binPath: string, plugins: Plugins, rules: Rules, fixes: Fixes, formats?: OxlintFormat[], configPath?: string | undefined, tsconfigPath?: string | undefined);
+    version(): Promise<string>;
+    private getConfigCliArg;
+    private getTsConfigCliArg;
+    private getFormatCliArg;
+    run(paths?: string[]): Promise<OxlintMultiFormatResult>;
+    toCliArgs(format: OxlintFormat, paths?: string[]): string[];
+    static create(options: OxlintNodeOptions): OxlintNode;
+}

package/dist/oxlint-node.docs.mdx

@@ -0,0 +1,68 @@
+---
+labels: ['Oxlint', 'module']
+description: 'A Node.js wrapper around oxlint binary.'
+---
+
+## Installation
+
+To install the Oxlint Node.js API, you can use `pnpm`, `npm`, or `yarn`.
+
+### Using `pnpm`
+
+```bash
+pnpm add @teambit/oxc.linter.oxlint-node
+```
+
+### Using `npm`
+
+```bash
+npm install @teambit/oxc.linter.oxlint-node
+```
+
+### Using `yarn`
+
+```bash
+yarn add @teambit/oxc.linter.oxlint-node
+```
+
+## Usage
+
+### Simple Usage
+
+```javascript
+import { OxlintNode } from '@teambit/oxc.linter.oxlint-node';
+
+const oxlintNode = OxlintNode.create({});
+const result = await oxlintNode.run(['paths']);
+console.log(result);
+```
+
+### Advanced Usage
+
+```javascript
+const oxlintNode = OxlintNode.create({
+  binPath: 'path to oxlint binary',
+  formats: ['json', 'default'],
+  configPath: 'path to oxlint config file',
+  tsconfigPath: 'path to tsconfig',
+  pluginsFlags: {
+    'plugin-name': true,
+  },
+  rulesFlags: [{
+    name: 'rule-name',
+    severity: 'warn',
+  }],
+  fixesFlags: {
+    all: true,
+  }
+});
+```
+
+### Other Related Components:
+
+- **Oxlint Env Example**: [bit.cloud/teambit/oxc/examples/envs/oxlint-env](https://bit.cloud/teambit/oxc/examples/envs/oxlint-env)
+- **Oxlint Linter**: [bit.cloud/teambit/oxc/linter/oxlint-linter](https://bit.cloud/teambit/oxc/linter/oxlint-linter)
+
+## Contributing
+
+We welcome contributions! Please read our [Contributing Guide](https://github.com/teambit/oxlint-node/blob/main/CONTRIBUTING.md) to get started.

package/dist/oxlint-node.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OxlintNode = void 0;
+const execa_1 = __importDefault(require("execa"));
+const resolve_bin_1 = require("./resolve-bin");
+const plugins_1 = require("./plugins");
+const rules_1 = require("./rules");
+const fixes_1 = require("./fixes");
+class OxlintNode {
+    constructor(binPath, plugins, rules, fixes, formats = ['default'], configPath, tsconfigPath) {
+        this.binPath = binPath;
+        this.plugins = plugins;
+        this.rules = rules;
+        this.fixes = fixes;
+        this.formats = formats;
+        this.configPath = configPath;
+        this.tsconfigPath = tsconfigPath;
+    }
+    async version() {
+        const { stdout: version } = await (0, execa_1.default)(this.binPath, ['--version']);
+        return version;
+    }
+    getConfigCliArg() {
+        return this.configPath ? `--config=${this.configPath}` : '';
+    }
+    getTsConfigCliArg() {
+        return this.configPath ? `--tsconfig=${this.configPath}` : '';
+    }
+    getFormatCliArg(format) {
+        return `--format=${format}`;
+    }
+    async run(paths = []) {
+        const result = {};
+        await Promise.all(this.formats.map(async (format) => {
+            const { stdout } = await (0, execa_1.default)(this.binPath, this.toCliArgs(format, paths));
+            result[format] = stdout;
+            if (format === 'json') {
+                result[format] = JSON.parse(stdout);
+            }
+        }));
+        return result;
+    }
+    toCliArgs(format, paths = []) {
+        const args = [
+            ...this.plugins.toCliArgs(),
+            ...this.rules.toCliArgs(),
+            ...this.fixes.toCliArgs(),
+            this.getConfigCliArg(),
+            this.getTsConfigCliArg(),
+            this.getFormatCliArg(format),
+            ...paths,
+        ];
+        return args;
+    }
+    static create(options) {
+        const plugins = plugins_1.Plugins.from(options.pluginsFlags || {});
+        const rules = rules_1.Rules.from(options.rulesFlags || []);
+        const fixes = fixes_1.Fixes.from(options.fixesFlags || {});
+        const binPath = options.binPath ||
+            (0, resolve_bin_1.resolveBin)('oxlint', { executable: 'oxlint', paths: [__dirname] });
+        return new OxlintNode(binPath, plugins, rules, fixes, options.formats, options.configPath, options.tsconfigPath);
+    }
+}
+exports.OxlintNode = OxlintNode;
+//# sourceMappingURL=oxlint-node.js.map

package/dist/oxlint-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oxlint-node.js","sourceRoot":"","sources":["../oxlint-node.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,+CAA2C;AAE3C,uCAAoC;AACpC,mCAAgC;AAChC,mCAAgC;AAIhC,MAAa,UAAU;IACrB,YACS,OAAe,EACf,OAAgB,EAChB,KAAY,EACZ,KAAY,EACZ,UAA0B,CAAC,SAAS,CAAC,EACrC,UAAmB,EACnB,YAAqB;QANrB,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;QACZ,UAAK,GAAL,KAAK,CAAO;QACZ,YAAO,GAAP,OAAO,CAA8B;QACrC,eAAU,GAAV,UAAU,CAAS;QACnB,iBAAY,GAAZ,YAAY,CAAS;IAC3B,CAAC;IAEJ,KAAK,CAAC,OAAO;QACX,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,eAAK,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QACrE,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,eAAe;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,CAAC;IAEO,iBAAiB;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,CAAC;IAEO,eAAe,CAAC,MAAoB;QAC1C,OAAO,YAAY,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,QAAkB,EAAE;QAC5B,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAChC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,eAAK,EAC5B,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAC9B,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;YACxB,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,SAAS,CAAC,MAAoB,EAAE,QAAkB,EAAE;QAClD,MAAM,IAAI,GAAG;YACX,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAC3B,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACzB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,iBAAiB,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;YAC5B,GAAG,KAAK;SACT,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAA0B;QACtC,MAAM,OAAO,GAAG,iBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,aAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,aAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,OAAO,GACX,OAAO,CAAC,OAAO;YACf,IAAA,wBAAU,EAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAErE,OAAO,IAAI,UAAU,CACnB,OAAO,EACP,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,YAAY,CACrB,CAAC;IACJ,CAAC;CACF;AA5ED,gCA4EC"}

package/dist/oxlint-node.spec.d.ts

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

package/dist/oxlint-node.spec.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oxlint_node_1 = require("./oxlint-node");
+it('renders with the correct version', async () => {
+    const oxlintNode = oxlint_node_1.OxlintNode.create({});
+    const version = await oxlintNode.version();
+    expect(version).toContain('0.9.5');
+});
+describe('run', () => {
+    describe('with default options', () => {
+        let oxlintNode;
+        beforeAll(() => {
+            oxlintNode = oxlint_node_1.OxlintNode.create({});
+        });
+        it('runs oxlint successfully with no files', async () => {
+            const result = await oxlintNode.run();
+            expect(result.default).toContain('Finished');
+            expect(result.default).toContain('Found 0 warnings and 0 errors');
+        });
+        it('runs oxlint successfully on the current file', async () => {
+            const result = await oxlintNode.run([__filename]);
+            expect(result.default).toContain('Finished');
+            expect(result.default).toContain('on 1 file');
+            expect(result.default).toContain('Found 0 warnings and 0 errors');
+        });
+    });
+});
+//# sourceMappingURL=oxlint-node.spec.js.map

package/dist/oxlint-node.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oxlint-node.spec.js","sourceRoot":"","sources":["../oxlint-node.spec.ts"],"names":[],"mappings":";;AAAA,+CAA2C;AAE3C,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;IAChD,MAAM,UAAU,GAAG,wBAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC3C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;IACnB,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,IAAI,UAAsB,CAAC;QAC3B,SAAS,CAAC,GAAG,EAAE;YACb,UAAU,GAAG,wBAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,GAAG,EAAE,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/plugins.d.ts

@@ -0,0 +1,22 @@
+export type PluginsFlags = Partial<{
+    react: boolean;
+    unicorn: boolean;
+    oxc: boolean;
+    typescript: boolean;
+    import: boolean;
+    jsdoc: boolean;
+    jest: boolean;
+    vitest: boolean;
+    'jsx-a11y': boolean;
+    nextjs: boolean;
+    'react-perf': boolean;
+    promise: boolean;
+}>;
+export type PluginsNames = keyof PluginsFlags;
+export declare class Plugins {
+    flags: PluginsFlags;
+    pluginsEnabledByDefault: PluginsNames[];
+    constructor(flags: PluginsFlags);
+    toCliArgs(): string[];
+    static from(flags: PluginsFlags): Plugins;
+}

package/dist/plugins.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugins = void 0;
+class Plugins {
+    constructor(flags) {
+        this.flags = flags;
+        this.pluginsEnabledByDefault = ['react', 'unicorn', 'oxc', 'typescript'];
+    }
+    toCliArgs() {
+        return Object.keys(this.flags).reduce((acc, key) => {
+            const enabledByDefault = this.pluginsEnabledByDefault.includes(key);
+            if (this.flags[key] && !enabledByDefault) {
+                acc.push(`--${key}-plugin`);
+            }
+            if (!this.flags[key] && enabledByDefault) {
+                acc.push(`--disable-${key}-plugin`);
+            }
+            return acc;
+        }, []);
+    }
+    static from(flags) {
+        return new Plugins(flags);
+    }
+}
+exports.Plugins = Plugins;
+//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../plugins.ts"],"names":[],"mappings":";;;AAiBA,MAAa,OAAO;IAGlB,YAAmB,KAAmB;QAAnB,UAAK,GAAL,KAAK,CAAc;QAFtC,4BAAuB,GAAmB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IAE3C,CAAC;IAE1C,SAAS;QACP,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjD,MAAM,gBAAgB,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,GAAmB,CAAC,CAAC;YACpF,IAAI,IAAI,CAAC,KAAK,CAAC,GAAmB,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACzD,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;YAC9B,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAmB,CAAC,IAAI,gBAAgB,EAAE,CAAC;gBACzD,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;YACtC,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAc,CAAC,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAmB;QAC7B,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;CACF;AArBD,0BAqBC"}

package/dist/preview-1726651799114.js

@@ -0,0 +1,7 @@
+;
+import * as overview_0 from '/Users/giladshoham/Library/Caches/Bit/capsules/root/c1c3547a2/teambit.oxc_linter_oxlint-node@0.0.1/dist/oxlint-node.docs.mdx';
+
+export const compositions = [];
+export const overview = [overview_0];
+
+export const compositions_metadata = {"compositions":[]};

package/dist/resolve-bin.d.ts

@@ -0,0 +1,4 @@
+export declare function resolveBin(moduleName: string, { executable, paths, }?: {
+    executable?: string;
+    paths?: string[];
+}): string;

package/dist/resolve-bin.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveBin = resolveBin;
+// TODO: move to another package / component
+const find_root_1 = __importDefault(require("find-root"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+function resolveBin(moduleName, { executable = moduleName, paths = [process.cwd()], } = {}) {
+    let rootDir;
+    try {
+        const resolved = require.resolve(moduleName, { paths });
+        rootDir = (0, find_root_1.default)(resolved);
+    }
+    catch (e) {
+        const modJson = require.resolve(`${moduleName}/package.json`, { paths });
+        rootDir = path_1.default.dirname(modJson);
+    }
+    const packageJsonPath = path_1.default.join(rootDir, 'package.json');
+    const packageJson = fs_extra_1.default.readJsonSync(packageJsonPath);
+    if (!packageJson.bin) {
+        throw new Error(`no bin found in ${packageJson.name}@${packageJson.version} in path ${packageJsonPath}`);
+    }
+    const binProp = typeof packageJson.bin === 'string'
+        ? packageJson.bin
+        : packageJson.bin[executable];
+    const binPath = path_1.default.join(rootDir, binProp);
+    return binPath;
+}
+//# sourceMappingURL=resolve-bin.js.map

package/dist/resolve-bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-bin.js","sourceRoot":"","sources":["../resolve-bin.ts"],"names":[],"mappings":";;;;;AAKA,gCA8BC;AAnCD,4CAA4C;AAC5C,0DAAiC;AACjC,gDAAwB;AACxB,wDAA0B;AAE1B,SAAgB,UAAU,CACxB,UAAkB,EAClB,EACE,UAAU,GAAG,UAAU,EACvB,KAAK,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MACsB,EAAE;IAEjD,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,OAAO,GAAG,IAAA,mBAAQ,EAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,UAAU,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACzE,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAE3D,MAAM,WAAW,GAAG,kBAAE,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrD,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,mBAAmB,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,YAAY,eAAe,EAAE,CACxF,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GACX,OAAO,WAAW,CAAC,GAAG,KAAK,QAAQ;QACjC,CAAC,CAAC,WAAW,CAAC,GAAG;QACjB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/rules.d.ts

@@ -0,0 +1,14 @@
+export type Category = 'correctness' | 'suspicious' | 'pedantic' | 'style' | 'nursery' | 'restriction' | 'all';
+export type Severity = 'allow' | 'warn' | 'deny';
+export type Rule = string;
+export type RuleSeverity = {
+    name: Rule | Category;
+    severity: Severity;
+};
+export type RulesFlags = RuleSeverity[];
+export declare class Rules {
+    flags: RulesFlags;
+    constructor(flags: RulesFlags);
+    toCliArgs(): string[];
+    static from(flags: RulesFlags): Rules;
+}

package/dist/rules.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rules = void 0;
+class Rules {
+    constructor(flags) {
+        this.flags = flags;
+    }
+    toCliArgs() {
+        return this.flags.map(({ name, severity }) => {
+            return (`--${severity}=${name}`);
+        });
+    }
+    static from(flags) {
+        return new Rules(flags);
+    }
+}
+exports.Rules = Rules;
+//# sourceMappingURL=rules.js.map

package/dist/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../rules.ts"],"names":[],"mappings":";;;AAWA,MAAa,KAAK;IAChB,YAAmB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAExC,SAAS;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAC,EAAE,EAAE;YACzC,OAAM,CAAC,KAAK,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAiB;QAC3B,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF;AAZD,sBAYC"}

package/fixes.ts

@@ -0,0 +1,28 @@
+export type FixesFlags = Partial<{
+  all: boolean;
+  suggestions: boolean;
+  dangerously: boolean;
+}>;
+
+export type FixType = keyof FixesFlags;
+
+export class Fixes {
+  constructor(public flags: FixesFlags) {}
+
+  toCliArgs(): string[] {
+    return Object.keys(this.flags).reduce((acc, key) => {
+      if (this.flags[key as FixType]) {
+        if (key === 'all') {
+          acc.push('--fix');
+        } else {
+          acc.push(`--fix-${key}`);
+        }
+      }
+      return acc;
+    }, [] as string[]);
+  }
+
+  static from(flags: FixesFlags): Fixes {
+    return new Fixes(flags);
+  }
+}

package/index.ts

@@ -0,0 +1,2 @@
+export { OxlintNode } from './oxlint-node';
+export type { OxlintNodeOptions } from './options';

package/options.ts

@@ -0,0 +1,42 @@
+import { FixesFlags } from './fixes';
+import { PluginsFlags } from './plugins';
+import { RulesFlags } from './rules';
+
+export type OxlintFormat = 'default' | 'json' | 'unix' | 'checkstyle' | 'github';
+
+export type OxlintNodeOptions = {
+  /**
+   * path to oxlint config file to use during linting
+   */
+  configPath?: string;
+
+  /**
+   * path to tsconfig to use during compilation.
+   */
+  tsconfigPath?: string;
+
+  /**
+   * decide the format for the CLI output.
+   */
+  formats?: OxlintFormat[];
+
+  /**
+   * decide the plugins to enable.
+   */
+  pluginsFlags?: PluginsFlags;
+
+  /**
+   * decide the rules / categories to enable.
+   */
+  rulesFlags?: RulesFlags;
+
+  /**
+   * decide the fixes to enable.
+   */
+  fixesFlags?: FixesFlags;
+
+  /**
+   * path to oxlint binary.
+   */
+  binPath?: any;
+};

package/oxlint-node.docs.mdx

@@ -0,0 +1,68 @@
+---
+labels: ['Oxlint', 'module']
+description: 'A Node.js wrapper around oxlint binary.'
+---
+
+## Installation
+
+To install the Oxlint Node.js API, you can use `pnpm`, `npm`, or `yarn`.
+
+### Using `pnpm`
+
+```bash
+pnpm add @teambit/oxc.linter.oxlint-node
+```
+
+### Using `npm`
+
+```bash
+npm install @teambit/oxc.linter.oxlint-node
+```
+
+### Using `yarn`
+
+```bash
+yarn add @teambit/oxc.linter.oxlint-node
+```
+
+## Usage
+
+### Simple Usage
+
+```javascript
+import { OxlintNode } from '@teambit/oxc.linter.oxlint-node';
+
+const oxlintNode = OxlintNode.create({});
+const result = await oxlintNode.run(['paths']);
+console.log(result);
+```
+
+### Advanced Usage
+
+```javascript
+const oxlintNode = OxlintNode.create({
+  binPath: 'path to oxlint binary',
+  formats: ['json', 'default'],
+  configPath: 'path to oxlint config file',
+  tsconfigPath: 'path to tsconfig',
+  pluginsFlags: {
+    'plugin-name': true,
+  },
+  rulesFlags: [{
+    name: 'rule-name',
+    severity: 'warn',
+  }],
+  fixesFlags: {
+    all: true,
+  }
+});
+```
+
+### Other Related Components:
+
+- **Oxlint Env Example**: [bit.cloud/teambit/oxc/examples/envs/oxlint-env](https://bit.cloud/teambit/oxc/examples/envs/oxlint-env)
+- **Oxlint Linter**: [bit.cloud/teambit/oxc/linter/oxlint-linter](https://bit.cloud/teambit/oxc/linter/oxlint-linter)
+
+## Contributing
+
+We welcome contributions! Please read our [Contributing Guide](https://github.com/teambit/oxlint-node/blob/main/CONTRIBUTING.md) to get started.

package/oxlint-node.spec.ts

@@ -0,0 +1,28 @@
+import { OxlintNode } from './oxlint-node';
+
+it('renders with the correct version', async () => {
+  const oxlintNode = OxlintNode.create({});
+  const version = await oxlintNode.version();
+  expect(version).toContain('0.9.5');
+});
+
+describe('run', () => {
+  describe('with default options', () => {
+    let oxlintNode: OxlintNode;
+    beforeAll(() => {
+      oxlintNode = OxlintNode.create({});
+    });
+    it('runs oxlint successfully with no files', async () => {
+      const result = await oxlintNode.run();
+      expect(result.default).toContain('Finished');
+      expect(result.default).toContain('Found 0 warnings and 0 errors');
+    });
+
+    it('runs oxlint successfully on the current file', async () => {
+      const result = await oxlintNode.run([__filename]);
+      expect(result.default).toContain('Finished');
+      expect(result.default).toContain('on 1 file');
+      expect(result.default).toContain('Found 0 warnings and 0 errors');
+    });
+  });
+});

package/oxlint-node.ts

@@ -0,0 +1,86 @@
+import execa from 'execa';
+import { resolveBin } from './resolve-bin';
+import { OxlintFormat, OxlintNodeOptions } from './options';
+import { Plugins } from './plugins';
+import { Rules } from './rules';
+import { Fixes } from './fixes';
+
+export type OxlintMultiFormatResult = Partial<Record<OxlintFormat, any>>;
+
+export class OxlintNode {
+  constructor(
+    public binPath: string,
+    public plugins: Plugins,
+    public rules: Rules,
+    public fixes: Fixes,
+    public formats: OxlintFormat[] = ['default'],
+    public configPath?: string,
+    public tsconfigPath?: string
+  ) {}
+
+  async version() {
+    const { stdout: version } = await execa(this.binPath, ['--version']);
+    return version;
+  }
+
+  private getConfigCliArg(): string {
+    return this.configPath ? `--config=${this.configPath}` : '';
+  }
+
+  private getTsConfigCliArg(): string {
+    return this.configPath ? `--tsconfig=${this.configPath}` : '';
+  }
+
+  private getFormatCliArg(format: OxlintFormat): string {
+    return `--format=${format}`;
+  }
+
+  async run(paths: string[] = []): Promise<OxlintMultiFormatResult> {
+    const result: OxlintMultiFormatResult = {};
+    await Promise.all(
+      this.formats.map(async (format) => {
+        const { stdout } = await execa(
+          this.binPath,
+          this.toCliArgs(format, paths)
+        );
+        result[format] = stdout;
+        if (format === 'json') {
+          result[format] = JSON.parse(stdout);
+        }
+      })
+    );
+    return result;
+  }
+
+  toCliArgs(format: OxlintFormat, paths: string[] = []): string[] {
+    const args = [
+      ...this.plugins.toCliArgs(),
+      ...this.rules.toCliArgs(),
+      ...this.fixes.toCliArgs(),
+      this.getConfigCliArg(),
+      this.getTsConfigCliArg(),
+      this.getFormatCliArg(format),
+      ...paths,
+    ];
+    return args;
+  }
+
+  static create(options: OxlintNodeOptions): OxlintNode {
+    const plugins = Plugins.from(options.pluginsFlags || {});
+    const rules = Rules.from(options.rulesFlags || []);
+    const fixes = Fixes.from(options.fixesFlags || {});
+    const binPath =
+      options.binPath ||
+      resolveBin('oxlint', { executable: 'oxlint', paths: [__dirname] });
+
+    return new OxlintNode(
+      binPath,
+      plugins,
+      rules,
+      fixes,
+      options.formats,
+      options.configPath,
+      options.tsconfigPath
+    );
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@teambit/oxc.linter.oxlint-node",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "componentId": {
+    "name": "linter/oxlint-node",
+    "version": "0.0.1",
+    "scope": "teambit.oxc"
+  },
+  "dependencies": {
+    "execa": "^5",
+    "find-root": "^1.1.0",
+    "fs-extra": "^11.2.0",
+    "oxlint": "0.9.5"
+  },
+  "devDependencies": {
+    "@types/find-root": "^1.1.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^18.11.9",
+    "@types/jest": "^29.2.2",
+    "@teambit/node.node": "1.0.88"
+  },
+  "peerDependencies": {},
+  "license": "SEE LICENSE IN UNLICENSED",
+  "optionalDependencies": {},
+  "peerDependenciesMeta": {},
+  "private": false,
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/oxlint-node"
+  },
+  "keywords": [
+    "bit",
+    "oxc",
+    "linter",
+    "oxlint",
+    "node",
+    "typescript",
+    "javascript"
+  ]
+}

package/plugins.ts

@@ -0,0 +1,39 @@
+export type PluginsFlags = Partial<{
+  react: boolean;
+  unicorn: boolean;
+  oxc: boolean;
+  typescript: boolean;
+  import: boolean;
+  jsdoc: boolean;
+  jest: boolean;
+  vitest: boolean;
+  'jsx-a11y': boolean;
+  nextjs: boolean;
+  'react-perf': boolean;
+  promise: boolean;
+}>;
+
+export type PluginsNames = keyof PluginsFlags;
+
+export class Plugins {
+  pluginsEnabledByDefault: PluginsNames[] = ['react', 'unicorn', 'oxc', 'typescript'];
+  
+  constructor(public flags: PluginsFlags) {}
+
+  toCliArgs(): string[] {
+    return Object.keys(this.flags).reduce((acc, key) => {
+      const enabledByDefault = this.pluginsEnabledByDefault.includes(key as PluginsNames);
+      if (this.flags[key as PluginsNames] && !enabledByDefault) {
+        acc.push(`--${key}-plugin`);
+      }
+      if (!this.flags[key as PluginsNames] && enabledByDefault) {
+        acc.push(`--disable-${key}-plugin`);
+      }
+      return acc;
+    }, [] as string[]);
+  }
+
+  static from(flags: PluginsFlags): Plugins {
+    return new Plugins(flags);
+  }
+}

package/resolve-bin.ts

@@ -0,0 +1,36 @@
+// TODO: move to another package / component
+import findRoot from 'find-root';
+import path from 'path';
+import fs from 'fs-extra';
+
+export function resolveBin(
+  moduleName: string,
+  {
+    executable = moduleName,
+    paths = [process.cwd()],
+  }: { executable?: string; paths?: string[] } = {}
+): string {
+  let rootDir;
+  try {
+    const resolved = require.resolve(moduleName, { paths });
+    rootDir = findRoot(resolved);
+  } catch (e) {
+    const modJson = require.resolve(`${moduleName}/package.json`, { paths });
+    rootDir = path.dirname(modJson);
+  }
+  const packageJsonPath = path.join(rootDir, 'package.json');
+
+  const packageJson = fs.readJsonSync(packageJsonPath);
+  if (!packageJson.bin) {
+    throw new Error(
+      `no bin found in ${packageJson.name}@${packageJson.version} in path ${packageJsonPath}`
+    );
+  }
+
+  const binProp =
+    typeof packageJson.bin === 'string'
+      ? packageJson.bin
+      : packageJson.bin[executable];
+  const binPath = path.join(rootDir, binProp);
+  return binPath;
+}

package/rules.ts

@@ -0,0 +1,24 @@
+export type Category = 'correctness'|'suspicious'|'pedantic'|'style'|'nursery'|'restriction'|'all';
+export type Severity = 'allow'|'warn'|'deny';
+// TODO: add specific rules
+export type Rule = string;
+
+export type RuleSeverity = {
+  name: Rule | Category;
+  severity: Severity;
+}
+export type RulesFlags = RuleSeverity[];
+
+export class Rules {
+  constructor(public flags: RulesFlags) {}
+
+  toCliArgs(): string[] {
+    return this.flags.map(({name, severity}) => {
+      return(`--${severity}=${name}`);
+    });
+  }
+
+  static from(flags: RulesFlags): Rules {
+    return new Rules(flags);
+  }
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
+  const src: string;
+  export default src;
+}
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}