@terra-symposium/standards-quality 0.0.0-stage → 0.5.0

package/dist/naming.d.ts

@@ -0,0 +1,148 @@
+/**
+ * packages/quality/src/naming.ts
+ * Renames identifiers according to the configured replacement rules.
+ */
+import ts from 'typescript';
+import type { QualityAnalysis, QualityCfg } from './runner.js';
+/** Context used when shortening an identifier without changing its meaning. */
+type RenameKind = {
+    numericIndex?: boolean;
+    callback?: boolean;
+    reserved?: string[];
+};
+export declare const IDENTIFIER_REPLACEMENTS: Readonly<Record<string, string>>;
+export declare const PREFIX_REPLACEMENTS: Readonly<Record<string, string>>;
+export declare const CALLBACK_ALIASES: Readonly<Record<string, string>>;
+export declare const CALLBACK_METHODS: Set<string>;
+export declare const PROTECTED_IDENTIFIERS: Set<string>;
+export declare const PROTECTED_PATH_PARTS: Set<string>;
+export declare const PROTECTED_FILENAMES: Set<string>;
+export declare const CODE_EXTS: Set<string>;
+/** A naming issue or concise-name suggestion found in one source file. */
+export type NamingFinding = {
+    file: string;
+    name: string;
+    suggestion: string;
+    severity: 'error' | 'warning';
+    start: number;
+};
+/** A declaration that only gives an existing symbol a second local name. */
+export type AliasFinding = {
+    file: string;
+    line: number;
+    kind: 'const' | 'type';
+    name: string;
+    replacement: string;
+};
+/**
+ * Splits an identifier into words while preserving acronym and numeric boundaries.
+ *
+ * @param name Identifier to tokenize.
+ *
+ * @return Identifier word tokens in source order.
+ */
+export declare function identifierTokens(name: string): string[];
+/**
+ * Chooses the preferred one-letter alias for a callback parameter without colliding with local names.
+ *
+ * @param name Existing callback parameter name.
+ * @param reserved Names already used in the callback scope.
+ *
+ * @return A concise available callback alias.
+ */
+export declare function callbackAlias(name: string, reserved?: string[]): string;
+/**
+ * Produces the configured concise form of an identifier, including callback and numeric-index aliases.
+ *
+ * @param name Identifier to shorten.
+ * @param kind Context flags controlling callback, index, and reserved-name handling.
+ *
+ * @return Concise identifier, or the original name when no safe replacement applies.
+ */
+export declare function renameId(name: string, kind?: RenameKind): string;
+/**
+ * Returns whether a declaration belongs to a supported callback.
+ *
+ * @param node Identifier declaration to inspect.
+ *
+ * @return `true` when the declaration is a supported callback parameter.
+ */
+export declare function isCallbackDeclaration(node: ts.Identifier): boolean;
+/**
+ * Returns the context-aware concise suggestion for one repository-owned declaration.
+ *
+ * @param n Identifier declaration whose context determines the suggestion.
+ *
+ * @return Concise name appropriate for the declaration's scope and callback role.
+ */
+export declare function renameDeclaration(n: ts.Identifier): string;
+/**
+ * Checks whether an identifier starts with a configured prefix replacement.
+ *
+ * @param name Identifier to inspect.
+ *
+ * @return `true` when its first token has a configured concise prefix.
+ */
+export declare function hasPrefixReplacement(name: string): boolean;
+/**
+ * Checks whether a path is protected from symbol renaming because it is generated or framework-owned.
+ *
+ * @param fileName Path to inspect.
+ *
+ * @return `true` for declaration files and configured protected path segments.
+ */
+export declare function isProtectedPath(fileName: string): boolean;
+/**
+ * Checks whether a filename is a framework convention whose declarations must retain their names.
+ *
+ * @param fileName Path or basename to inspect.
+ *
+ * @return `true` when the basename is a protected route or component filename.
+ */
+export declare function isProtectedFilename(fileName: string): boolean;
+/**
+ * Reports whether an identifier already satisfies the configured concise-name rules.
+ *
+ * @param name Identifier to validate.
+ * @param kind Context flags used when the identifier is a callback or index parameter.
+ *
+ * @return `true` when renaming would produce the same identifier.
+ */
+export declare function isApprovedId(name: string, kind?: RenameKind): boolean;
+/**
+ * Returns whether an identifier declares a repository-owned symbol safe to rename with all references.
+ *
+ * @param n Identifier declaration to classify.
+ *
+ * @return `true` when all references can be updated as a repository-local rename.
+ */
+export declare function isRenamableDeclaration(n: ts.Identifier): boolean;
+/**
+ * Returns the function or source-file scope that owns a declaration.
+ *
+ * @param n Identifier whose owning function or source-file scope is required.
+ *
+ * @return The nearest function-like scope, or the source file when no function owns it.
+ */
+export declare function declarationScope(n: ts.Identifier): ts.Node;
+/**
+ * Reports concise-name drift without mutating the consumer repository.
+ *
+ * @param cfg Quality configuration defining source scope and naming protections.
+ * @param analysis Optional shared program and source cache for the current quality run.
+ *
+ * @return Concise-name findings for declarations that can be renamed safely.
+ */
+export declare function namingFindings(cfg: QualityCfg, analysis?: QualityAnalysis): NamingFinding[];
+/**
+ * Finds and optionally removes declarations that only rename another symbol.
+ *
+ * @param cfg Quality configuration defining the source scope and protected identifiers.
+ * @param analysisOrFix Shared analysis context, or the legacy boolean autofix flag.
+ * @param legacyFix Autofix flag used when an analysis context is supplied.
+ *
+ * @return Alias declarations that can be removed, whether or not autofix is enabled.
+ */
+export declare function aliasFindings(cfg: QualityCfg, analysisOrFix?: QualityAnalysis | boolean, legacyFix?: boolean): AliasFinding[];
+export {};
+//# sourceMappingURL=naming.d.ts.map

package/dist/naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../src/naming.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,MAAM,YAAY,CAAC;AAK5B,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAO/D,+EAA+E;AAC/E,KAAK,UAAU,GAAG;IAAE,YAAY,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AACtF,eAAO,MAAM,uBAAuB,kCA4ClC,CAAC;AACH,eAAO,MAAM,mBAAmB,kCAS9B,CAAC;AACH,eAAO,MAAM,gBAAgB,kCAoB5B,CAAC;AACF,eAAO,MAAM,gBAAgB,aAgB3B,CAAC;AACH,eAAO,MAAM,qBAAqB,aAsBhC,CAAC;AACH,eAAO,MAAM,oBAAoB,aAAsF,CAAC;AACxH,eAAO,MAAM,mBAAmB,aAA6J,CAAC;AAC9L,eAAO,MAAM,SAAS,aAA0E,CAAC;AACjG,0EAA0E;AAC1E,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAM7H,4EAA4E;AAC5E,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AA+BrH;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAKvD;AAgCD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAM,EAAO,GAAG,MAAM,CAM3E;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,MAAM,CAiBpE;AAwFD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,GAAG,OAAO,CAElE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,GAAG,MAAM,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAMzD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,OAAO,CAEzE;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,GAAG,OAAO,CAsBhE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,IAAI,CAkB1D;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,aAAa,EAAE,CAoC3F;AAkBD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,GAAE,eAAe,GAAG,OAAe,EAAE,SAAS,UAAQ,GAAG,YAAY,EAAE,CAsHlI"}