@w5s/dev 3.2.3 → 3.3.2

package/dist/index.d.ts

@@ -1,167 +1,36 @@
 import { ESLint } from "eslint";
 
-//#region src/directory.d.ts
-interface DirectoryOptions {
-  /**
-   * Directory path
-   */
-  readonly path: string;
-  /**
-   * Directory target state
-   */
-  readonly state: 'present' | 'absent';
-}
-/**
- * Ensure directory is present/absent
- *
- * @example
- * ```ts
- * await directory({
- *   path: 'foo/bar',
- *   state: 'present',
- * })
- * ```
- *
- * @param options
- */
-declare function directory(options: DirectoryOptions): Promise<void>;
-/**
- * Ensure directory is present/absent
- *
- * @example
- * ```ts
- * await directorySync({
- *   path: 'foo/bar',
- *   state: 'present',
- * })
- * ```
- *
- * @param options
- */
-declare function directorySync(options: DirectoryOptions): void;
-//#endregion
 //#region src/ESLintConfig.d.ts
-declare namespace ESLintConfig {
-  /**
-   *
-   * @param configs
-   */
-  function concat(...configs: ESLint.ConfigData[]): ESLint.ConfigData;
-  /**
-   * Always return 'off'. `_status` is the previous rule value.
-   *
-   * @param _status
-   */
-  function fixme(_status: string | number | [string | number, ...any[]] | undefined): "off";
-  /**
-   * Renames rules in the given object according to the given map.
-   *
-   * Given a map `{ 'old-prefix': 'new-prefix' }`, and a rule object
-   * `{ 'old-prefix/rule-name': 'error' }`, this function will return
-   * `{ 'new-prefix/rule-name': 'error' }`.
-   *
-   * @param rules The object containing the rules to rename.
-   * @param map The object containing the rename map.
-   */
-  function renameRules(rules: Record<string, any>, map: Record<string, string>): Record<string, any>;
-}
-//#endregion
-//#region src/block.d.ts
-interface BlockOptions {
-  /**
-   * The marker builder function that will take either `markerBegin` or `markerEnd`
-   *
-   * @default '# ${mark} MANAGED BLOCK'
-   */
-  marker?: (mark: 'Begin' | 'End') => string;
-  /**
-   * File path
-   */
-  path: string;
-  /**
-   * Block content to insert
-   */
-  block: string;
-  /**
-   * Insert position
-   */
-  insertPosition?: ['before', 'BeginningOfFile' | RegExp] | ['after', 'EndOfFile' | RegExp];
-  /**
-   * Block target state
-   */
-  state?: 'present' | 'absent';
-}
 /**
- * Replace asynchronously a block in file that follows pattern :
- *
- * marker(markerBegin)
- * ...
- * marker(markerEnd)
  *
- * @param options
+ * @param configs
  */
-declare function block(options: BlockOptions): Promise<void>;
+declare function concat(...configs: ESLint.ConfigData[]): ESLint.ConfigData;
 /**
- * Replace synchronously a block in file that follows pattern :
- *
- * marker(markerBegin)
- * ...
- * marker(markerEnd)
+ * Always return 'off'. `_status` is the previous rule value.
  *
- * @param options
+ * @param _status
  */
-declare function blockSync(options: BlockOptions): void;
-//#endregion
-//#region src/file.d.ts
-interface FileOptions {
-  /**
-   * File path
-   */
-  readonly path: string;
-  /**
-   * File target state
-   */
-  readonly state: 'present' | 'absent';
-  /**
-   * File content mapping function
-   *
-   */
-  readonly update?: ((content: string) => string | undefined) | undefined;
-  /**
-   * File encoding
-   */
-  readonly encoding?: BufferEncoding;
-}
+declare function fixme(_status: string | number | [string | number, ...any[]] | undefined): "off";
 /**
- * Ensure file is present/absent with content initialized or modified with `update
+ * Renames rules in the given object according to the given map.
  *
- * @example
- * ```ts
- * await file({
- *   path: 'foo/bar',
- *   state: 'present',
- *   update: (content) => content + '_test', // This will append '_test' after current content
- * })
- * ```
+ * Given a map `{ 'old-prefix': 'new-prefix' }`, and a rule object
+ * `{ 'old-prefix/rule-name': 'error' }`, this function will return
+ * `{ 'new-prefix/rule-name': 'error' }`.
  *
- * @param options
+ * @param rules The object containing the rules to rename.
+ * @param map The object containing the rename map.
  */
-declare function file(options: FileOptions): Promise<void>;
+declare function renameRules(rules: Record<string, any>, map: Record<string, string>): Record<string, any>;
 /**
- * Ensure file is present/absent with content initialized or modified with `update
- *
- * @example
- * ```ts
- * fileSync({
- *   path: 'foo/bar',
- *   state: 'present',
- *   update: (content) => content + '_test', // This will append '_test' after current content
- * })
- * ```
- *
- * @param options
+ * @namespace
  */
-declare function fileSync(options: FileOptions): void;
+declare const ESLintConfig: Readonly<{
+  concat: typeof concat;
+  fixme: typeof fixme;
+  renameRules: typeof renameRules;
+}>;
 //#endregion
 //#region src/interopDefault.d.ts
 /**
@@ -214,41 +83,6 @@ interface LanguageIdMap {
  */
 type LanguageId = keyof LanguageIdMap;
 //#endregion
-//#region src/json.d.ts
-type JSONValue = null | number | string | boolean | JSONValue[] | {
-  [key: string]: JSONValue;
-};
-interface JSONOption<V = JSONValue> {
-  /**
-   * File path
-   */
-  readonly path: string;
-  /**
-   * File target state
-   */
-  readonly state: 'present' | 'absent';
-  /**
-   * File content mapping function
-   */
-  readonly update?: ((content: V | undefined) => V | undefined) | undefined;
-  /**
-   * File encoding
-   */
-  readonly encoding?: BufferEncoding;
-}
-/**
- * Ensure file is present/absent asynchronously with content value initialized or modified with `update`
- *
- * @param options
- */
-declare function json<Value>(options: JSONOption<Value>): Promise<void>;
-/**
- * Ensure file is present/absent synchronously with content value initialized or modified with `update`
- *
- * @param options
- */
-declare function jsonSync<Value>(options: JSONOption<Value>): void;
-//#endregion
 //#region src/meta.d.ts
 declare const meta: Readonly<{
   name: string;
@@ -257,84 +91,91 @@ declare const meta: Readonly<{
 }>;
 //#endregion
 //#region src/Project.d.ts
-declare namespace Project {
-  /**
-   * A type of a file extension
-   */
-  type Extension = `.${string}`;
-  /**
-   * Object hash of all well-known file extension category to file extensions mapping
-   */
-  type ExtensionRegistry = { [K in LanguageId]: readonly Extension[] };
-  /**
-   * Supported ECMA version
-   *
-   * @example
-   * ```ts
-   * Project.ecmaVersion() // 2022
-   * ```
-   */
-  function ecmaVersion(): 2022;
-  /**
-   * Return a list of extensions
-   *
-   * @example
-   * ```ts
-   * Project.queryExtensions(['javascript']); // ['.js', '.cjs', ...]
-   * Project.queryExtensions(['typescript', 'typescriptreact']); // ['.ts', '.mts', ..., '.tsx']
-   * ```
-   *
-   * @param languages
-   */
-  function queryExtensions(languages: LanguageId[]): readonly Extension[];
-  /**
-   * Supported file extensions
-   *
-   * @example
-   * ```ts
-   * Project.sourceExtensions() // ['.ts', '.js', ...]
-   * ```
-   */
-  function sourceExtensions(): readonly `.${string}`[];
-  /**
-   * Resource file extensions
-   *
-   * @example
-   * ```ts
-   * Project.resourceExtensions() // ['.css', '.sass', ...]
-   * ```
-   */
-  function resourceExtensions(): readonly `.${string}`[];
-  /**
-   * Files and folders to always ignore
-   *
-   * @example
-   * ```ts
-   * IGNORED // ['node_modules/', 'build/', ...]
-   * ```
-   */
-  function ignored(): readonly string[];
-  /**
-   * Return a RegExp that will match any list of extensions
-   *
-   * @param extensions
-   * @example
-   * ```ts
-   * Project.extensionsToMatcher(['.js', '.ts']) // RegExp = /(\.js|\.ts)$/
-   * ```
-   */
-  function extensionsToMatcher(extensions: readonly Extension[]): RegExp;
-  /**
-   * Return a glob matcher that will match any list of extensions
-   *
-   * @param extensions
-   * @example
-   * ```ts
-   * Project.extensionsToGlob(['.js', '.ts']) // '*.+(js|ts)'
-   * ```
-   */
-  function extensionsToGlob(extensions: readonly Extension[]): string;
-}
+/**
+ * A type of a file extension
+ */
+type Extension = `.${string}`;
+/**
+ * Object hash of all well-known file extension category to file extensions mapping
+ */
+type ExtensionRegistry = { [K in LanguageId]: readonly Extension[] };
+/**
+ * Supported ECMA version
+ *
+ * @example
+ * ```ts
+ * Project.ecmaVersion() // 2022
+ * ```
+ */
+declare function ecmaVersion(): 2022;
+/**
+ * Return a list of extensions
+ *
+ * @example
+ * ```ts
+ * Project.queryExtensions(['javascript']); // ['.js', '.cjs', ...]
+ * Project.queryExtensions(['typescript', 'typescriptreact']); // ['.ts', '.mts', ..., '.tsx']
+ * ```
+ *
+ * @param languages
+ */
+declare function queryExtensions(languages: LanguageId[]): readonly Extension[];
+/**
+ * Supported file extensions
+ *
+ * @example
+ * ```ts
+ * Project.sourceExtensions() // ['.ts', '.js', ...]
+ * ```
+ */
+declare function sourceExtensions(): readonly `.${string}`[];
+/**
+ * Resource file extensions
+ *
+ * @example
+ * ```ts
+ * Project.resourceExtensions() // ['.css', '.sass', ...]
+ * ```
+ */
+declare function resourceExtensions(): readonly `.${string}`[];
+/**
+ * Files and folders to always ignore
+ *
+ * @example
+ * ```ts
+ * IGNORED // ['node_modules/', 'build/', ...]
+ * ```
+ */
+declare function ignored(): readonly string[];
+/**
+ * Return a RegExp that will match any list of extensions
+ *
+ * @param extensions
+ * @example
+ * ```ts
+ * Project.extensionsToMatcher(['.js', '.ts']) // RegExp = /(\.js|\.ts)$/
+ * ```
+ */
+declare function extensionsToMatcher(extensions: readonly Extension[]): RegExp;
+/**
+ * Return a glob matcher that will match any list of extensions
+ *
+ * @param extensions
+ * @example
+ * ```ts
+ * Project.extensionsToGlob(['.js', '.ts']) // '*.+(js|ts)'
+ * ```
+ */
+declare function extensionsToGlob(extensions: readonly Extension[]): string;
+declare const Project: Readonly<{
+  ecmaVersion: typeof ecmaVersion;
+  extensionsToGlob: typeof extensionsToGlob;
+  extensionsToMatcher: typeof extensionsToMatcher;
+  ignored: typeof ignored;
+  queryExtensions: typeof queryExtensions;
+  resourceExtensions: typeof resourceExtensions;
+  sourceExtensions: typeof sourceExtensions;
+}>;
 //#endregion
 //#region src/ProjectScript.d.ts
 /**
@@ -355,86 +196,10 @@ declare const ProjectScript: {
   readonly Rescue: "rescue";
   readonly Spellcheck: "spellcheck";
   readonly Test: "test";
+  readonly Typecheck: "typecheck";
   readonly Validate: "validate";
 };
 type ProjectScript = (typeof ProjectScript)[keyof typeof ProjectScript];
 //#endregion
-//#region src/yarnConfig.d.ts
-interface YarnConfigOptions {
-  /**
-   * Configuration key
-   */
-  readonly key: string;
-  /**
-   * Option target state
-   */
-  readonly state: 'present' | 'absent';
-  /**
-   * File content mapping function
-   *
-   */
-  readonly update?: ((content: string) => string | undefined) | undefined;
-}
-/**
- * Synchronous version of {@link yarnConfig}
- *
- * @param options
- * @example
- * yarnConfigSync({
- *   key: 'nodeLinker',
- *   state: 'present',
- *   update: (content) => content.replace('node-modules', 'hoisted'),
- * })
- */
-declare function yarnConfigSync(options: YarnConfigOptions): void;
-/**
- * Set/Unset yarn configuration value
- *
- * @param options
- * @example
- * await yarnConfig({
- *   key: 'nodeLinker',
- *   state: 'present',
- *   update: (content) => content.replace('node-modules', 'hoisted'),
- * })
- */
-declare function yarnConfig(options: YarnConfigOptions): Promise<void>;
-//#endregion
-//#region src/yarnVersion.d.ts
-type YarnVersionKind = 'berry' | 'classic';
-interface YarnVersionOptions {
-  /**
-   * Option target state
-   */
-  readonly state: 'present' | 'absent';
-  /**
-   * Version mapping function
-   *
-   */
-  readonly update?: (() => YarnVersionKind | undefined) | undefined;
-}
-/**
- * Synchronous version of {@link yarnVersion}
- *
- * @param options
- * @example
- * yarnVersionSync({
- *   state: 'present',
- *   update: () => 'berry', // or 'classic'
- * })
- */
-declare function yarnVersionSync(options: YarnVersionOptions): void;
-/**
- * Set/Unset yarn configuration value
- *
- * @param options
- * @example
- * await yarnVersion({
- *   state: 'present',
- *   update: () => 'berry', // or 'classic'
- * })
- */
-declare function yarnVersion(options: YarnVersionOptions): Promise<void>;
-//#endregion
-export { BlockOptions, DirectoryOptions, ESLintConfig, FileOptions, JSONOption, JSONValue, LanguageId, LanguageIdMap, Project, ProjectScript, YarnConfigOptions, YarnVersionKind, YarnVersionOptions, block, blockSync, directory, directorySync, file, fileSync, interopDefault, json, jsonSync, meta, yarnConfig, yarnConfigSync, yarnVersion, yarnVersionSync };
+export { ESLintConfig, Extension, ExtensionRegistry, LanguageId, LanguageIdMap, Project, ProjectScript, interopDefault, meta };
 //# sourceMappingURL=index.d.ts.map