Part 11 (#573)

Author: tclindner

src/Config.ts

@@ -1,6 +1,6 @@
 const debug = require('debug')('npm-package-json-lint:Config');
 import {cosmiconfigSync} from 'cosmiconfig';
-import {validate} from './config/ConfigValidator';
+import {validate, validateRules} from './config/ConfigValidator';
 import {transform} from './config/cosmicConfigTransformer';
 import {applyExtendsIfSpecified} from './config/applyExtendsIfSpecified';
 import {applyOverrides} from './config/applyOverrides';
@@ -11,7 +11,13 @@ const noRules = 0;
  * Config class
  * @class
  */
-class Config {
+export class Config {
+  config: any;
+  cwd: string;
+  configFile: any;
+  configBaseDirectory: any;
+  rules: any;
+
   /**
    * Constructor
    *
@@ -81,10 +87,8 @@ class Config {
     debug('Final Config');
     debug(config);
 
-    validate(config, 'cli', this.rules);
+    validateRules(config, 'cli', this.rules);
 
     return config;
   }
 }
-
-module.exports = Config;

src/NpmPackageJsonLint.ts

@@ -7,6 +7,7 @@ import {Rules} from './Rules';
 import {executeOnPackageJsonFiles, executeOnPackageJsonObject} from './linter/linter';
 import {getFileList} from './utils/getFileList';
 import {getIgnorer} from './utils/getIgnorer';
+import { Severity } from './types/severity';
 
 const noIssues = 0;
 
@@ -18,7 +19,7 @@ const noIssues = 0;
  * @private
  */
 const isIssueAnError = (issue) => {
-  return issue.severity === 'error';
+  return issue.severity === Severity.Error;
 };
 
 const isPackageJsonObjectValid = (packageJsonObject) => isPlainObj(packageJsonObject);
@@ -67,28 +68,55 @@ const getErrorResults = (results) => {
  * @property {Object<string,*>} rules   An object of rules to use.
  */
 
+export interface NpmPackageJsonLintOptions {
+  cwd?: string,
+  packageJsonObject?: any,
+  packageJsonFilePath?: string,
+  config?: any,
+  configFile?: any,
+  configBaseDirectory?: any,
+  patterns?: any,
+  quiet?: boolean,
+  ignorePath?: string,
+  fix?: boolean,
+}
+
 /**
  * Public CLIEngine class
  * @class
  */
 export class NpmPackageJsonLint {
+  cwd: string;
+  packageJsonObject: any;
+  packageJsonFilePath: string;
+  patterns: any;
+  quiet: boolean;
+  ignorePath: string;
+  fix: boolean;
+  version: string;
+  rules: Rules;
+  configHelper: Config;
+
+
   /**
    * constructor
    * @param {NpmPackageJsonLint} options The options for the CLIEngine.
    * @constructor
    */
-  constructor({
-    cwd,
-    packageJsonObject,
-    packageJsonFilePath,
-    config,
-    configFile,
-    configBaseDirectory,
-    patterns,
-    quiet,
-    ignorePath,
-    fix,
-  }) {
+  constructor(options: NpmPackageJsonLintOptions) {
+    const {
+      cwd,
+      packageJsonObject,
+      packageJsonFilePath,
+      config,
+      configFile,
+      configBaseDirectory,
+      patterns,
+      quiet,
+      ignorePath,
+      fix,
+    } = options;
+
     this.cwd = slash(cwd || process.cwd());
 
     this.packageJsonObject = packageJsonObject;

src/Rules.ts

@@ -3,6 +3,8 @@ import fs from 'fs';
 import path from 'path';
 
 export class Rules {
+  rules: any;
+
   /**
    * Constructor
    */

src/config/ConfigSchema.ts

@@ -22,7 +22,7 @@ const standardRuleSchema = {
   },
 };
 
-const arrayRuleSchema = (minItems) => ({
+const arrayRuleSchema = (minItems: any ): any  => ({
   type: 'array',
   items: [
     standardRuleSchema,
@@ -133,7 +133,7 @@ const configurationSchema = {
  * @param {Object} ruleConfig The ruleConfig object to validate.
  * @returns {boolean} True if valid. Error if not.
  */
-export const isStandardRuleSchemaValid = (ruleConfig) => {
+export const isStandardRuleSchemaValid = (ruleConfig: any ): any  => {
   const validate = ajv.compile(standardRuleSchema);
   const isValid = validate(ruleConfig);
 
@@ -151,7 +151,7 @@ export const isStandardRuleSchemaValid = (ruleConfig) => {
  * @param {number} minItems   Min number of items in the array
  * @returns {boolean} True if valid. Error if not.
  */
-export const isArrayRuleSchemaValid = (ruleConfig, minItems) => {
+export const isArrayRuleSchemaValid = (ruleConfig: any , minItems: any ): any  => {
   const validate = ajv.compile(arrayRuleSchema(minItems));
   const isValid = validate(ruleConfig);
 
@@ -168,7 +168,7 @@ export const isArrayRuleSchemaValid = (ruleConfig, minItems) => {
  * @param {Object} ruleConfig The ruleConfig object to validate.
  * @returns {boolean} True if valid. Error if not.
  */
-export const isObjectRuleSchemaValid = (ruleConfig) => {
+export const isObjectRuleSchemaValid = (ruleConfig: any ): any  => {
   const validate = ajv.compile(objectRuleSchema);
   const isValid = validate(ruleConfig);
 
@@ -185,7 +185,7 @@ export const isObjectRuleSchemaValid = (ruleConfig) => {
  * @param {Object} ruleConfig The ruleConfig object to validate.
  * @returns {boolean} True if valid. Error if not.
  */
-export const isOptionalObjExceptSchemaValid = (ruleConfig) => {
+export const isOptionalObjExceptSchemaValid = (ruleConfig: any ): any  => {
   const validate = ajv.compile(optionalObjExceptionsSchema);
   const isValid = validate(ruleConfig);
 
@@ -203,7 +203,7 @@ export const isOptionalObjExceptSchemaValid = (ruleConfig) => {
  * @param {string} source The name of the configuration source to report in any errors.
  * @returns {boolean} True if valid. Error if not.
  */
-export const isConfigObjectSchemaValid = (config, source) => {
+export const isConfigObjectSchemaValid = (config: any , source: any ): any  => {
   const validate = ajv.compile(configurationSchema);
   const isValid = validate(config);
 

src/config/ConfigValidator.ts

@@ -7,7 +7,7 @@ import {isArrayRuleSchemaValid, isConfigObjectSchemaValid, isObjectRuleSchemaVal
  * @return {Boolean}               True if config is valid, false if not
  * @static
  */
-const isObjectRuleConfigValid = (ruleConfig) => {
+const isObjectRuleConfigValid = (ruleConfig: any ): any  => {
   if (typeof ruleConfig === 'string' && ruleConfig === 'off') {
     return true;
   }
@@ -26,7 +26,7 @@ const isObjectRuleConfigValid = (ruleConfig) => {
  * @return {Boolean}              True if config is valid, false if not
  * @static
  */
-const isOptionalObjRuleConfigValid = (ruleConfig) => {
+const isOptionalObjRuleConfigValid = (ruleConfig: any ): any  => {
   const object = 1;
 
   if (typeof ruleConfig === 'string') {
@@ -48,7 +48,7 @@ const isOptionalObjRuleConfigValid = (ruleConfig) => {
  * @return {Boolean}               True if config is valid, false if not
  * @static
  */
-const isArrayRuleConfigValid = (ruleConfig, minItems) => {
+const isArrayRuleConfigValid = (ruleConfig: any , minItems: any ): any  => {
   if (typeof ruleConfig === 'string' && ruleConfig === 'off') {
     return true;
   }
@@ -67,7 +67,7 @@ const isArrayRuleConfigValid = (ruleConfig, minItems) => {
  * @return {Boolean}                True if config is valid, error if not
  * @static
  */
-const isStandardRuleConfigValid = (ruleConfig) => isStandardRuleSchemaValid(ruleConfig);
+const isStandardRuleConfigValid = (ruleConfig: any ): any  => isStandardRuleSchemaValid(ruleConfig);
 
 /**
  * Validates configuration of a rule
@@ -78,7 +78,7 @@ const isStandardRuleConfigValid = (ruleConfig) => isStandardRuleSchemaValid(rule
  * @param {String|null} source The name of the configuration source to report in any errors.
  * @returns {undefined} No return
  */
-const validateRule = (ruleModule, ruleName, userConfig, source) => {
+const validateRule = (ruleModule: any , ruleName: any , userConfig: any , source: any ): any  => {
   if (ruleModule) {
     try {
       switch (ruleModule.ruleType) {
@@ -121,7 +121,7 @@ const validateRule = (ruleModule, ruleName, userConfig, source) => {
  * @returns {undefined} No return
  * @static
  */
-export const validateRules = (rulesConfig, source, rules) => {
+export const validateRules = (rulesConfig: any , source: any , rules: any ): any  => {
   if (!rulesConfig) {
     return;
   }
@@ -142,7 +142,7 @@ export const validateRules = (rulesConfig, source, rules) => {
  * @returns {undefined} No return
  * @static
  */
-export const validate = (config, source, rules) => {
+export const validate = (config: any , source: any , rules: any ): any  => {
   isConfigObjectSchemaValid(config, source);
   validateRules(config.rules, source, rules);
 };

src/config/applyExtendsIfSpecified.ts

@@ -11,7 +11,7 @@ import {Parser} from '../Parser';
  * @returns {Object} A new configuration object with all of the 'extends' fields loaded and merged.
  * @private
  */
-const applyExtends = (config, parentName, originalFilePath) => {
+const applyExtends = (config: any , parentName: any , originalFilePath: any ): any => {
   let configExtends = config.extends;
 
   if (!Array.isArray(config.extends)) {
@@ -68,7 +68,7 @@ const applyExtends = (config, parentName, originalFilePath) => {
  * @return {Object}                  Configuration object
  * @private
  */
-const loadFromModule = (moduleName, originalFilePath) => {
+const loadFromModule = (moduleName: any , originalFilePath: any ): any  => {
   let config = {};
   let adjustedModuleName = moduleName;
 
@@ -83,6 +83,7 @@ const loadFromModule = (moduleName, originalFilePath) => {
     config = require(resolvedModule);
   }
 
+  // @ts-expect-error
   if (Object.keys(config).length > 0 && config.extends) {
     config = applyExtends(config, adjustedModuleName, originalFilePath);
   }
@@ -98,7 +99,7 @@ const loadFromModule = (moduleName, originalFilePath) => {
  * @returns {Object} The configuration information.
  * @private
  */
-const loadConfigFile = (filePath) => {
+const loadConfigFile = (filePath: any ): any  => {
   let config = {};
 
   switch (path.extname(filePath)) {
@@ -125,7 +126,7 @@ const loadConfigFile = (filePath) => {
  * @returns {Object} the parsed config object (empty object if there was a parse error)
  * @private
  */
-export const applyExtendsIfSpecified = (npmPackageJsonLintConfig, filepath) => {
+export const applyExtendsIfSpecified = (npmPackageJsonLintConfig: any , filepath: any ): any  => {
   let config = {...npmPackageJsonLintConfig};
 
   debug('Loading extends, if applicable');

src/config/applyOverrides.ts

@@ -11,7 +11,7 @@ import globby from 'globby';
  * @returns {Object} A new configuration object with all of the 'overrides' applied.
  * @private
  */
-export const applyOverrides = (cwd: string, filePath: string, rules: any, overrides: any): any => {
+export const applyOverrides = (cwd: string, filePath: string, rules: any, overrides?: any[]): any => {
   let finalRules = {...rules};
 
   debug('overrides');

src/config/cosmicConfigTransformer.ts

@@ -3,7 +3,7 @@ const debug = require('debug')('npm-package-json-lint:cosmicConfigTransformer');
 import {applyExtendsIfSpecified} from './applyExtendsIfSpecified';
 import {applyOverrides} from './applyOverrides';
 
-export const transform = (cwd, configBaseDirectory, filePathBeingLinted) => {
+export const transform = (cwd: any , configBaseDirectory: any , filePathBeingLinted: any ): any  => {
   debug(`cwd: ${cwd}`);
   debug(`configBaseDirectory`);
   debug(configBaseDirectory);

src/linter/linter.ts

@@ -1,7 +1,9 @@
 const debug = require('debug')('npm-package-json-lint:linter');
 import path from 'path';
 import {Parser} from '../Parser';
-import {resultsHelper} from './results-helper';
+import { RuleType } from '../types/rule-type';
+import { Severity } from '../types/severity';
+import {aggregateCountsPerFile, aggregateOverallCounts} from './results-helper';
 
 /**
  * A package.json file linting result.
@@ -48,13 +50,13 @@ const lint = (packageJsonData, configObj, rules) => {
   for (const rule in configObj) {
     const ruleModule = rules.get(rule);
 
-    let severity = 'off';
+    let severity = Severity.Off;
     let ruleConfig = {};
 
-    if (ruleModule.ruleType === 'array' || ruleModule.ruleType === 'object') {
+    if (ruleModule.ruleType === RuleType.Array || ruleModule.ruleType === RuleType.Object) {
       severity = typeof configObj[rule] === 'string' && configObj[rule] === 'off' ? configObj[rule] : configObj[rule][0];
       ruleConfig = typeof configObj[rule] === 'string' ? {} : configObj[rule][1];
-    } else if (ruleModule.ruleType === 'optionalObject') {
+    } else if (ruleModule.ruleType === RuleType.OptionalObject) {
       if (typeof configObj[rule] === 'string') {
         severity = configObj[rule];
         ruleConfig = {};
@@ -66,7 +68,7 @@ const lint = (packageJsonData, configObj, rules) => {
       severity = configObj[rule];
     }
 
-    if (severity !== 'off') {
+    if (severity !== Severity.Off) {
       const lintResult = ruleModule.lint(packageJsonData, severity, ruleConfig);
 
       if (typeof lintResult === 'object') {
@@ -91,7 +93,7 @@ const lint = (packageJsonData, configObj, rules) => {
  */
 const processPackageJsonObject = (cwd, packageJsonObj, config, fileName, rules) => {
   const lintIssues = lint(packageJsonObj, config, rules);
-  const counts = resultsHelper.aggregateCountsPerFile(lintIssues);
+  const counts = aggregateCountsPerFile(lintIssues);
   const result = createResultObject({
     cwd,
     fileName,
@@ -140,7 +142,7 @@ const processPackageJsonFile = (cwd, fileName, config, rules) => {
  * @param {Object} rules An instance of `Rules`.
  * @returns {LinterResult} The results {@link LinterResult} from linting a collection of package.json files.
  */
-export const executeOnPackageJsonObject = ({cwd, packageJsonObject, filename, ignorer, configHelper, rules}) => {
+export const executeOnPackageJsonObject = ({cwd, packageJsonObject, filename, ignorer, configHelper, rules}): any => {
   debug('executing on package.json object');
   const results = [];
 
@@ -172,7 +174,7 @@ export const executeOnPackageJsonObject = ({cwd, packageJsonObject, filename, ig
   }
 
   debug('Aggregating overall counts');
-  const stats = resultsHelper.aggregateOverallCounts(results);
+  const stats = aggregateOverallCounts(results);
 
   debug('stats');
   debug(stats);
@@ -194,7 +196,7 @@ export const executeOnPackageJsonObject = ({cwd, packageJsonObject, filename, ig
  * @param {Object} rules An instance of `Rules`.
  * @returns {LinterResult} The results {@link LinterResult} from linting a collection of package.json files.
  */
-export const executeOnPackageJsonFiles = ({cwd, fileList, ignorer, configHelper, rules}) => {
+export const executeOnPackageJsonFiles = ({cwd, fileList, ignorer, configHelper, rules}): any => {
   debug('executing on package.json files');
   const results = fileList.map((filePath) => {
     const relativeFilePath = path.relative(cwd, filePath);
@@ -221,7 +223,7 @@ export const executeOnPackageJsonFiles = ({cwd, fileList, ignorer, configHelper,
   });
 
   debug('Aggregating overall counts');
-  const stats = resultsHelper.aggregateOverallCounts(results);
+  const stats = aggregateOverallCounts(results);
 
   debug('stats');
   debug(stats);