New Config API + Typescript conversion: WIP

command.js → command.ts

@@ -1,6 +1,17 @@
-const spec = require('conventional-changelog-config-spec')
-const { getConfiguration } = require('./lib/configuration')
-const defaults = require('./defaults')
+// @ts-nocheck
+/*
+I haven't been able to find API docs for yargs that explain the runtime semantics thoroughly enough to describe the types,
+and the types give do not appear to agree with the usage below. This leads me to believe the types are either incorrect or incomplete,
+and adding types to Yargs is outside of scope.
+
+As a compromise, `argv` is manually typed, and the type must be updated as changes are made below. There is a
+[separate isssue](https://github.com/absolute-version/commit-and-tag-version/issues/31) for refactoring the API to bring the CLI
+options to parity with the JSON options, which would likely involve breaking changes.
+*/
+
+import spec from 'conventional-changelog-config-spec/versions/2.1.0/schema.json'
+import { getConfiguration } from './lib/configuration'
+import defaults from './defaults'
 
 const yargs = require('yargs')
   .usage('Usage: $0 [options]')
@@ -148,7 +159,7 @@ const yargs = require('yargs')
   .wrap(97)
 
 Object.keys(spec.properties).forEach((propertyKey) => {
-  const property = spec.properties[propertyKey]
+  const property = spec.properties[propertyKey as keyof typeof spec.properties]
   yargs.option(propertyKey, {
     type: property.type,
     describe: property.description,

defaults.ts

@@ -0,0 +1,85 @@
+import spec from "conventional-changelog-config-spec/versions/2.1.0/schema.json";
+
+type Defaults = Readonly<
+  {
+    infile: string;
+    firstRelease: boolean;
+    sign: boolean;
+    noVerify: boolean;
+    commitAll: boolean;
+    silent: boolean;
+    tagPrefix: string;
+    releaseCount: number;
+    scripts: {
+      prerelease?: string;
+      prebump?: string;
+      postbump?: string;
+      prechangelog?: string;
+      postchangelog?: string;
+      precommit?: string;
+      postcommit?: string;
+      pretag?: string;
+      posttag?: string;
+    };
+    skip: {
+      bump?: boolean;
+      changelog?: boolean;
+      commit?: boolean;
+      tag?: boolean;
+    };
+    dryRun: boolean;
+    tagForce: boolean;
+    gitTagFallback: boolean;
+    preset: string;
+    npmPublishHint: string | undefined;
+    packageFiles: readonly string[];
+    bumpFiles: readonly string[];
+  } & {
+    [key in keyof typeof spec.properties]: typeof spec.properties[key]["default"];
+  }
+>;
+
+const defaults = {
+  infile: "CHANGELOG.md",
+  firstRelease: false,
+  sign: false,
+  noVerify: false,
+  commitAll: false,
+  silent: false,
+  tagPrefix: "v",
+  releaseCount: 1,
+  scripts: {},
+  skip: {},
+  dryRun: false,
+  tagForce: false,
+  gitTagFallback: true,
+  preset: require.resolve('conventional-changelog-conventionalcommits'),
+  npmPublishHint: undefined,
+  /**
+   * Sets the default for `header` (provided by the spec) for backwards
+   * compatibility. This should be removed in the next major version.
+   */
+  header:
+    "# Changelog\n\nAll notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.\n",
+  packageFiles: ["package.json", "bower.json", "manifest.json"],
+  bumpFiles: [
+    "package.json",
+    "bower.json",
+    "manifest.json",
+    "package-lock.json",
+    "npm-shrinkwrap.json",
+  ],
+} as const satisfies Partial<Readonly<Defaults>>;
+
+/**
+ * Merge in defaults provided by the spec
+ */
+Object.keys(spec.properties).forEach((propertyKey) => {
+  const k: keyof typeof spec.properties =
+    propertyKey as keyof typeof spec.properties;
+  const property = spec.properties[k];
+  // @ts-expect-error - we know that the key exists
+  defaults[k] = property.default;
+});
+
+export default defaults as any as Defaults;

lib/configuration.js → lib/configuration.ts

@@ -1,30 +1,31 @@
-const path = require('path')
-const findUp = require('find-up')
-const { readFileSync } = require('fs')
+import path from 'path'
+import findUp from 'find-up'
+import { readFileSync } from 'fs'
+import { CatVConfig } from './opts'
 
 const CONFIGURATION_FILES = [
   '.versionrc',
-  '.versionrc.cjs',
   '.versionrc.json',
+  '.versionrc.cjs',
   '.versionrc.js'
-]
+] as const;
 
-module.exports.getConfiguration = function () {
-  let config = {}
+export async function getConfiguration () {
+  let config = {} as Partial<CatVConfig>
   const configPath = findUp.sync(CONFIGURATION_FILES)
   if (!configPath) {
     return config
   }
   const ext = path.extname(configPath)
   if (ext === '.js' || ext === '.cjs') {
-    const jsConfiguration = require(configPath)
+    const jsConfiguration = await import(configPath)
     if (typeof jsConfiguration === 'function') {
       config = jsConfiguration()
     } else {
       config = jsConfiguration
     }
   } else {
-    config = JSON.parse(readFileSync(configPath))
+    config = JSON.parse(readFileSync(configPath, 'utf-8'))
   }
 
   /**

lib/opts/index.ts

@@ -0,0 +1,122 @@
+import { getConfiguration as getConfigFile } from "../configuration";
+import { isin } from "../../type-helpers";
+import type { PrettyPrint } from "../../type-helpers";
+
+type Release = "minor" | "major" | "patch";
+type Task = "changelog" | "commit" | "tag";
+type Hook =
+  | "prerelease"
+  | "prebump"
+  | "postbump"
+  | "prechangelog"
+  | "postchangelog"
+  | "precommit"
+  | "postcommit"
+  | "pretag"
+  | "posttag";
+
+type TypePrefixes = Array<
+  (
+    | { section: string; hidden?: boolean | undefined }
+    | { hidden: true; section?: string | undefined }
+  ) & { type: string }
+>;
+
+type ConfigFiles = Array<
+  | string
+  | { filename: string; type: "json" | "gradle" | "plain-text" }
+  | { filename: string; updater: string }
+>;
+
+/**
+ * __THIS SHOULD NOT CHANGE.__
+ * @deprecated
+ *
+ * The configuration options for `standard-version` as of version 9.5 (The last version prior to the fork; deprecated).
+ */
+export type SVConfig = {
+  packageFiles: ConfigFiles;
+  bumpFiles: ConfigFiles;
+  releaseAs: Release;
+  prerelease: string | boolean;
+  infile: string;
+  message: string;
+  firstRelease: boolean;
+  sign: boolean;
+  noVerify: boolean;
+  commitAll: boolean;
+  silent: boolean;
+  tagPrefix: string;
+  scripts: Record<Hook, string>;
+  skip: Record<Task, string>;
+  dryRun: boolean;
+  gitTagFallback: boolean;
+  path: string;
+  changelogHeader: string;
+  preset: string;
+  lernaPackage: string;
+  header: string;
+  types: TypePrefixes;
+  preMajor: boolean;
+  commitUrlFormat: string;
+  compareUrlFormat: string;
+  issueUrlFormat: string;
+  userUrlFormat: string;
+  releaseCommitMessageFormat: string;
+  issuePrefixes: string[];
+};
+
+/**
+ * The configuration object for commit-and-tag-version, which is a superset of the conventional-changelog-config-spec (as of version 2.1.0)
+ * This may or may not maintain backwards compatibility with standard-version (as of version 9.5.0).
+ */
+export type CatVConfig = PrettyPrint<
+  SVConfig & {
+    npmPublishHint: string;
+    releaseCount: number;
+    tagForce: boolean;
+  }
+>;
+
+/** The configuration options that are not supported by standard-version (as of version 9.5.0). */
+const catVOnlyFeatures = [
+  "npmPublishHint",
+  "releaseCount",
+  "tagForce",
+] as const satisfies ReadonlyArray<Exclude<keyof CatVConfig, keyof SVConfig>>;
+
+export const getMergedConfig = async (
+  cwd?: string
+): Promise<Partial<CatVConfig>> => {
+  const dir = cwd ?? process.cwd();
+  const json = (await import("path")).join(dir, "package.json");
+  const svConfig: SVConfig = (await import(json))["standard-version"];
+  const catvConfig: CatVConfig = (await import(json))["commit-and-tag-version"];
+
+  const config: Partial<CatVConfig> = {};
+
+  if (svConfig) {
+    for (const key in svConfig) {
+      // @ts-expect-error - We know this key SHOULD NOT be in svConfig, but we're going to allow it and warn the user
+      if (catVOnlyFeatures.includes(key)) {
+        console.warn(
+          `The "${key}" option is a feature of commit-and-tag-version, and is not supported by standard-version.${"\n"}Please move this option to the 'commit-and-tag-version' key.${"\n"}In a future version, this will throw an error.`
+        );
+      }
+      if (isin(catvConfig, key)) {
+        console.warn(
+          `"standard-version"."${key}" in package.json is being overridden by "commit-and-tag-version"."${key}". in package.json`
+        );
+      }
+      // @ts-expect-error - We know better than TS here. This is valid.
+      config[key] = svConfig[key];
+    }
+  }
+  for (const key in catvConfig) {
+    // @ts-expect-error - We know better than TS here. This is valid.
+    config[key] = catvConfig[key];
+  }
+
+  const config2 = await getConfigFile();
+  return { ...config, ...config2 };
+};