@darksheep/eslint 4.1.8 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.2.0](https://github.com/DarkSheepSoftware/eslint/compare/v4.1.8...v4.2.0) (2024-03-06)
+
+
+### 💡 Features
+
+* builtin ts types ([564facf](https://github.com/DarkSheepSoftware/eslint/commit/564facf2e27b27e15db026118e5342dafb2cad8d))
+
+
+### 📦 Dependencies
+
+* **deps:** update yarn to v4.1.1 ([#282](https://github.com/DarkSheepSoftware/eslint/issues/282)) ([c9af1d8](https://github.com/DarkSheepSoftware/eslint/commit/c9af1d84596926fe2aa75c5e9cb20fc1e853452a))
+* **dev:** update dependency type-fest to v4.11.1 ([#258](https://github.com/DarkSheepSoftware/eslint/issues/258)) ([00a0fa3](https://github.com/DarkSheepSoftware/eslint/commit/00a0fa33ae4d7de182953a29a9b3ae786e3a396e))
+* **pkg:** update typescript-eslint monorepo to v7.1.1 ([#280](https://github.com/DarkSheepSoftware/eslint/issues/280)) ([7653003](https://github.com/DarkSheepSoftware/eslint/commit/765300359b074c5eec9d1dbc06474d2f307b43e6))
+
 ## [4.1.8](https://github.com/DarkSheepSoftware/eslint/compare/v4.1.7...v4.1.8) (2024-03-04)
 
 

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@darksheep/eslint",
-  "version": "4.1.8",
+  "version": "4.2.0",
   "type": "module",
-  "packageManager": "yarn@4.1.0",
+  "packageManager": "yarn@4.1.1",
   "bin": "./src/bin/eslint.cjs",
   "exports": {
-    ".": "./src/index.js"
+    ".": {
+      "import": "./src/index.js",
+      "types": "./types/src/index.d.ts"
+    }
   },
   "files": [
-    "src"
+    "src",
+    "types"
   ],
   "engines": {
     "node": "^20 || ^21"

package/types/eslint.config.d.ts

@@ -0,0 +1,2 @@
+export default config;
+declare const config: import("eslint").Linter.FlatConfig[];

package/types/src/bin/eslint.d.cts

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

package/types/src/configs/eslint-base.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the ESLint base config
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintBaseConfig(): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/configs/eslint-complexity.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the ESLint config for complexity checks
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintComplexityConfig(): import('eslint').Linter.FlatConfig[];

package/types/src/configs/eslint-ignores.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get basic ESLint ignores config
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintIgnoresConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/configs/eslint-recommended.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get recommended ESLint config
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintRecommendsConfig(): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/configs/eslint-style.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get basic ESLint style config
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createStyleConfigs(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/custom/index.d.ts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    let rules: {
+        'loose-types': import("eslint").Rule.RuleModule;
+        'no-useless-expression': import("eslint").Rule.RuleModule;
+        'sequence-expression': import("eslint").Rule.RuleModule;
+    };
+}
+export default _default;

package/types/src/custom/instance-of-array.d.ts

@@ -0,0 +1,3 @@
+export default rule;
+/** @type {import('eslint').Rule.RuleModule} */
+declare const rule: import('eslint').Rule.RuleModule;

package/types/src/custom/loose-types.d.ts

@@ -0,0 +1,3 @@
+export default rule;
+/** @type {import('eslint').Rule.RuleModule} */
+declare const rule: import('eslint').Rule.RuleModule;

package/types/src/custom/no-useless-expression.d.ts

@@ -0,0 +1,3 @@
+export default rule;
+/** @type {import('eslint').Rule.RuleModule} */
+declare const rule: import('eslint').Rule.RuleModule;

package/types/src/custom/sequence-expression.d.ts

@@ -0,0 +1,3 @@
+export default rule;
+/** @type {import('eslint').Rule.RuleModule} */
+declare const rule: import('eslint').Rule.RuleModule;

package/types/src/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * @param {string | URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createConfig(root: string | URL): Promise<import('eslint').Linter.FlatConfig[]>;
+export * from "eslint";
+import { URL } from 'node:url';

package/types/src/plugins/eslint-comments.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for comments check
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintCommentsConfig(): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/import.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for imports check
+ * @param {import('node:url').URL} root The root of the eslint config directory
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintImportConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/jest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config jest plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintJestConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/jsdoc.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for js docs
+ * @param {URL} root The root of the package being linted
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintJSDocConfig(root: URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/json.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for imports check
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintJsonConfig(): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/jsx-a11y.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for imports check
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintJsxA11yConfig(): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the node plugin
+ * @param {URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintNodeConfigs(root: URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/promise.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for the promise plugin
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintPromiseConfig(): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/react.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for imports check
+ * @param {URL} root The root of the package being linted
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintReactConfig(root: URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/regexp.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the regexp plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintRegexpConfig(root: import('node:url').URL): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/sca.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the sca plugin
+ * @param {URL} root The root url of the package we are linting
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintSCAConfig(root: URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/security.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for the security plugin
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintSecurityConfig(): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/sonarjs.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the sonar plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintSonarJSConfig(root: import('node:url').URL): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/style.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for the sonar plugin
+ * @returns {import('eslint').Linter.FlatConfig[]}
+ */
+export function createEslintStyleConfig(): import('eslint').Linter.FlatConfig[];

package/types/src/plugins/typescript.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the typescript plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintTypescriptConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/unicorn.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the unicorn plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintUnicornConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/plugins/unused-imports.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get ESLint config for the unused import plugin
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintUnusedImportsConfig(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;

package/types/src/utilities/editorconfig.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEditorOverrides(root: import('node:url').URL): Promise<import('eslint').Linter.FlatConfig[]>;
+export type RuleSet = {
+    /**
+     * end of line
+     */
+    EOL: string;
+    /**
+     * line feed
+     */
+    LF: string;
+    /**
+     * trailing spaces
+     */
+    TRAIL: string;
+    /**
+     * indent size
+     */
+    INDENT: string;
+    /**
+     * indent binary ops size
+     */
+    INDENT_BINARY?: string | undefined;
+};

package/types/src/utilities/eslint-files.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Get a list of globs for common js files
+ * @returns {Promise<string[]>}
+ */
+export function getJsonFiles(): Promise<string[]>;
+/**
+ * Get a list of globs for common js files
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<string[]>}
+ */
+export function getCommonFiles(root: import('node:url').URL): Promise<string[]>;
+/**
+ * Get a list of globs for module files
+ * @param {import('node:url').URL} root root url
+ * @returns {Promise<string[]>}
+ */
+export function getModuleFiles(root: import('node:url').URL): Promise<string[]>;
+/**
+ * Get a list of globs for typescript files
+ * @returns {string[]}
+ */
+export function getTypescriptFiles(): string[];
+/**
+ * Get a list of possible example files
+ * @returns {string[]}
+ */
+export function getTestFiles(): string[];
+/**
+ * Get a list of possible example files
+ * @returns {string[]}
+ */
+export function getExampleFiles(): string[];

package/types/src/utilities/expand-glob.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {string} input The glob to process
+ * @returns {string[]}
+ */
+export function expandGlob(input: string): string[];

package/types/src/utilities/filesystem.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @param {string} path The absolute path to the file to check
+ * @returns {Promise<boolean>}
+ */
+export function exists(path: string): Promise<boolean>;
+/**
+ * Does {filePath} exist in {projectPath}
+ * @param {string} [filePath] The path of the file to check
+ * @param {string} [projectPath] The path to the project root
+ * @returns {boolean}
+ */
+export function descendsFrom(filePath?: string | undefined, projectPath?: string | undefined): boolean;
+/**
+ * Create a list of parent directories from {filepath} to {stopDirectory}
+ * @param {string} filepath The file to start from
+ * @param {string} [stopDirectory] The directory to stop at
+ * @returns {string[]}
+ */
+export function listParents(filepath: string, stopDirectory?: string | undefined): string[];
+/**
+ * Find the closest {filename} starting from {rootFilePath}
+ * @param {string} rootFilePath The file to start the search from
+ * @param {string} filename The filename to find
+ * @param {string} [stopDirectory] The directory to stop searching at
+ * @returns {Promise<string|null>} Returns absolute path to the closest {filename} if found
+ */
+export function findUp(rootFilePath: string, filename: string, stopDirectory?: string | undefined): Promise<string | null>;

package/types/src/utilities/make-compat.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {import('node:url').URL} root root url
+ * @returns {import('@eslint/eslintrc').FlatCompat}
+ */
+export function makeCompat(root: import('node:url').URL): import('@eslint/eslintrc').FlatCompat;

package/types/src/utilities/package.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the path of the eslint package json
+ * @param {import('node:url').URL} root root url
+ * @param {string} [packageName] The name of the npm package
+ * @returns {Promise<import('type-fest').PackageJson | null>}
+ */
+export function getPackageJson(root: import('node:url').URL, packageName?: string | undefined): Promise<import('type-fest').PackageJson | null>;