conventional-changelog-storm-software 0.1.0

package/dist/chunk-ZPVHPMDE.cjs

@@ -0,0 +1,2 @@
+'use strict';
+

package/dist/commit-types.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+var chunkM7BTBQHL_cjs = require('./chunk-M7BTBQHL.cjs');
+require('./chunk-RR5776TG.cjs');
+
+
+
+Object.defineProperty(exports, "COMMIT_TYPES", {
+  enumerable: true,
+  get: function () { return chunkM7BTBQHL_cjs.COMMIT_TYPES; }
+});

package/dist/commit-types.d.cts

@@ -0,0 +1,130 @@
+/**
+ * Commit types available for selection in commit messages.
+ */
+declare const COMMIT_TYPES: {
+    readonly chore: {
+        readonly description: "Other changes that don't modify src or test files";
+        readonly title: "Chore";
+        readonly emoji: "⚙️  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Miscellaneous";
+            readonly hidden: false;
+        };
+    };
+    readonly fix: {
+        readonly description: "A change that resolves an issue previously identified with the package";
+        readonly title: "Bug Fix";
+        readonly emoji: "🪲  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Bug Fixes";
+            readonly hidden: false;
+        };
+    };
+    readonly feat: {
+        readonly description: "A change that adds a new feature to the package";
+        readonly title: "Feature";
+        readonly emoji: "🔑 ";
+        readonly semverBump: "minor";
+        readonly changelog: {
+            readonly title: "Features";
+            readonly hidden: false;
+        };
+    };
+    readonly ci: {
+        readonly description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)";
+        readonly title: "Continuous Integration";
+        readonly emoji: "🧰 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Continuous Integration";
+            readonly hidden: false;
+        };
+    };
+    readonly refactor: {
+        readonly description: "A code change that neither fixes a bug nor adds a feature";
+        readonly title: "Code Refactoring";
+        readonly emoji: "🧪 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Source Code Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly style: {
+        readonly description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)";
+        readonly title: "Style Improvements";
+        readonly emoji: "💎 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Style Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly perf: {
+        readonly description: "A code change that improves performance";
+        readonly title: "Performance Improvement";
+        readonly emoji: "⏱️  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Performance Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly docs: {
+        readonly description: "A change that only includes documentation updates";
+        readonly title: "Documentation";
+        readonly emoji: "📜 ";
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Documentation";
+            readonly hidden: false;
+        };
+    };
+    readonly test: {
+        readonly description: "Adding missing tests or correcting existing tests";
+        readonly title: "Testing";
+        readonly emoji: "🚨 ";
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Testing";
+            readonly hidden: true;
+        };
+    };
+    readonly deps: {
+        readonly description: "Changes that add, update, or remove dependencies. This includes devDependencies and peerDependencies";
+        readonly title: "Dependencies";
+        readonly emoji: "📦 ";
+        readonly hidden: true;
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Dependency Upgrades";
+            readonly hidden: false;
+        };
+    };
+    readonly build: {
+        readonly description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)";
+        readonly title: "Build";
+        readonly emoji: "🛠 ";
+        readonly hidden: true;
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Build";
+            readonly hidden: true;
+        };
+    };
+    readonly release: {
+        readonly description: "Publishing a commit containing a newly released version";
+        readonly title: "Publish Release";
+        readonly emoji: "🚀 ";
+        readonly hidden: true;
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Publish Release";
+            readonly hidden: true;
+        };
+    };
+};
+
+export { COMMIT_TYPES };

package/dist/commit-types.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Commit types available for selection in commit messages.
+ */
+declare const COMMIT_TYPES: {
+    readonly chore: {
+        readonly description: "Other changes that don't modify src or test files";
+        readonly title: "Chore";
+        readonly emoji: "⚙️  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Miscellaneous";
+            readonly hidden: false;
+        };
+    };
+    readonly fix: {
+        readonly description: "A change that resolves an issue previously identified with the package";
+        readonly title: "Bug Fix";
+        readonly emoji: "🪲  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Bug Fixes";
+            readonly hidden: false;
+        };
+    };
+    readonly feat: {
+        readonly description: "A change that adds a new feature to the package";
+        readonly title: "Feature";
+        readonly emoji: "🔑 ";
+        readonly semverBump: "minor";
+        readonly changelog: {
+            readonly title: "Features";
+            readonly hidden: false;
+        };
+    };
+    readonly ci: {
+        readonly description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)";
+        readonly title: "Continuous Integration";
+        readonly emoji: "🧰 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Continuous Integration";
+            readonly hidden: false;
+        };
+    };
+    readonly refactor: {
+        readonly description: "A code change that neither fixes a bug nor adds a feature";
+        readonly title: "Code Refactoring";
+        readonly emoji: "🧪 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Source Code Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly style: {
+        readonly description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)";
+        readonly title: "Style Improvements";
+        readonly emoji: "💎 ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Style Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly perf: {
+        readonly description: "A code change that improves performance";
+        readonly title: "Performance Improvement";
+        readonly emoji: "⏱️  ";
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Performance Improvements";
+            readonly hidden: false;
+        };
+    };
+    readonly docs: {
+        readonly description: "A change that only includes documentation updates";
+        readonly title: "Documentation";
+        readonly emoji: "📜 ";
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Documentation";
+            readonly hidden: false;
+        };
+    };
+    readonly test: {
+        readonly description: "Adding missing tests or correcting existing tests";
+        readonly title: "Testing";
+        readonly emoji: "🚨 ";
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Testing";
+            readonly hidden: true;
+        };
+    };
+    readonly deps: {
+        readonly description: "Changes that add, update, or remove dependencies. This includes devDependencies and peerDependencies";
+        readonly title: "Dependencies";
+        readonly emoji: "📦 ";
+        readonly hidden: true;
+        readonly semverBump: "patch";
+        readonly changelog: {
+            readonly title: "Dependency Upgrades";
+            readonly hidden: false;
+        };
+    };
+    readonly build: {
+        readonly description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)";
+        readonly title: "Build";
+        readonly emoji: "🛠 ";
+        readonly hidden: true;
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Build";
+            readonly hidden: true;
+        };
+    };
+    readonly release: {
+        readonly description: "Publishing a commit containing a newly released version";
+        readonly title: "Publish Release";
+        readonly emoji: "🚀 ";
+        readonly hidden: true;
+        readonly semverBump: "none";
+        readonly changelog: {
+            readonly title: "Publish Release";
+            readonly hidden: true;
+        };
+    };
+};
+
+export { COMMIT_TYPES };

package/dist/commit-types.js

@@ -0,0 +1 @@
+export { COMMIT_TYPES } from './chunk-2MZWLEPP.js';

package/dist/index.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var chunkUZZOYD6Y_cjs = require('./chunk-UZZOYD6Y.cjs');
+var chunkDL5576FZ_cjs = require('./chunk-DL5576FZ.cjs');
+var chunkUK5DQTL2_cjs = require('./chunk-UK5DQTL2.cjs');
+var chunkHVVJTAOT_cjs = require('./chunk-HVVJTAOT.cjs');
+require('./chunk-KRZANN66.cjs');
+var chunkYBJMQHWU_cjs = require('./chunk-YBJMQHWU.cjs');
+var chunkM7BTBQHL_cjs = require('./chunk-M7BTBQHL.cjs');
+require('./chunk-RR5776TG.cjs');
+
+// src/index.ts
+async function createPreset(config = {}) {
+  const options = await chunkUZZOYD6Y_cjs.resolveOptions(config);
+  return {
+    commits: {
+      ignore: config.ignoreCommits,
+      merges: false
+    },
+    parser: chunkDL5576FZ_cjs.createParserOpts(options.workspace.variant),
+    writer: await chunkHVVJTAOT_cjs.createWriterOpts(options),
+    whatBump: chunkUK5DQTL2_cjs.createWhatBump(options)
+  };
+}
+
+Object.defineProperty(exports, "CHANGELOG_COMMIT_TYPES", {
+  enumerable: true,
+  get: function () { return chunkYBJMQHWU_cjs.CHANGELOG_COMMITS; }
+});
+Object.defineProperty(exports, "COMMIT_TYPES", {
+  enumerable: true,
+  get: function () { return chunkM7BTBQHL_cjs.COMMIT_TYPES; }
+});
+exports.default = createPreset;

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+export { COMMIT_TYPES } from './commit-types.cjs';
+import { PresetConfig } from './types/config.cjs';
+import { StormSoftwarePreset } from './types/preset.cjs';
+export { CHANGELOG_COMMITS as CHANGELOG_COMMIT_TYPES } from './utilities/constants.cjs';
+import '@storm-software/config/types';
+import './types/write.cjs';
+
+/**
+ * Create a preset configuration for Storm Software changelog conventions.
+ *
+ * @param config - The configuration object.
+ * @returns The preset configuration.
+ */
+declare function createPreset(config?: PresetConfig): Promise<StormSoftwarePreset>;
+
+export { createPreset as default };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export { COMMIT_TYPES } from './commit-types.js';
+import { PresetConfig } from './types/config.js';
+import { StormSoftwarePreset } from './types/preset.js';
+export { CHANGELOG_COMMITS as CHANGELOG_COMMIT_TYPES } from './utilities/constants.js';
+import '@storm-software/config/types';
+import './types/write.js';
+
+/**
+ * Create a preset configuration for Storm Software changelog conventions.
+ *
+ * @param config - The configuration object.
+ * @returns The preset configuration.
+ */
+declare function createPreset(config?: PresetConfig): Promise<StormSoftwarePreset>;
+
+export { createPreset as default };

package/dist/index.js

@@ -0,0 +1,23 @@
+import { resolveOptions } from './chunk-ZLZS2G36.js';
+import { createParserOpts } from './chunk-O35EG2LQ.js';
+import { createWhatBump } from './chunk-LPCM2SVA.js';
+import { createWriterOpts } from './chunk-63544DKM.js';
+import './chunk-I6KKIB6V.js';
+export { CHANGELOG_COMMITS as CHANGELOG_COMMIT_TYPES } from './chunk-IJLTWVLG.js';
+export { COMMIT_TYPES } from './chunk-2MZWLEPP.js';
+
+// src/index.ts
+async function createPreset(config = {}) {
+  const options = await resolveOptions(config);
+  return {
+    commits: {
+      ignore: config.ignoreCommits,
+      merges: false
+    },
+    parser: createParserOpts(options.workspace.variant),
+    writer: await createWriterOpts(options),
+    whatBump: createWhatBump(options)
+  };
+}
+
+export { createPreset as default };

package/dist/parser.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+var chunkDL5576FZ_cjs = require('./chunk-DL5576FZ.cjs');
+require('./chunk-YBJMQHWU.cjs');
+require('./chunk-M7BTBQHL.cjs');
+require('./chunk-RR5776TG.cjs');
+
+
+
+Object.defineProperty(exports, "createParserOpts", {
+  enumerable: true,
+  get: function () { return chunkDL5576FZ_cjs.createParserOpts; }
+});

package/dist/parser.d.cts

@@ -0,0 +1,12 @@
+import { Variant } from '@storm-software/config/types';
+import { ParserConfig } from './types/config.cjs';
+
+/**
+ * Create parser options based on the provided config.
+ *
+ * @param config The configuration object.
+ * @returns The parser options.
+ */
+declare function createParserOpts(variant: Variant): ParserConfig;
+
+export { createParserOpts };

package/dist/parser.d.ts

@@ -0,0 +1,12 @@
+import { Variant } from '@storm-software/config/types';
+import { ParserConfig } from './types/config.js';
+
+/**
+ * Create parser options based on the provided config.
+ *
+ * @param config The configuration object.
+ * @returns The parser options.
+ */
+declare function createParserOpts(variant: Variant): ParserConfig;
+
+export { createParserOpts };

package/dist/parser.js

@@ -0,0 +1,3 @@
+export { createParserOpts } from './chunk-O35EG2LQ.js';
+import './chunk-IJLTWVLG.js';
+import './chunk-2MZWLEPP.js';

package/dist/types/commit-types.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+require('../chunk-RR5776TG.cjs');
+

package/dist/types/commit-types.d.cts

@@ -0,0 +1,19 @@
+import { COMMIT_TYPES } from '../commit-types.cjs';
+
+type CommitEnumItemProps = {
+    description: string;
+    title?: string;
+    emoji?: string;
+    hidden?: boolean;
+};
+type CommitTypeProps = CommitEnumItemProps & {
+    semverBump: "none" | "patch" | "minor" | "major";
+    changelog: {
+        title: string;
+        hidden: boolean;
+    };
+};
+type DefaultCommitTypeKeys = keyof typeof COMMIT_TYPES;
+type CommitTypesEnum<TCommitTypes extends DefaultCommitTypeKeys = DefaultCommitTypeKeys> = Record<TCommitTypes, CommitTypeProps>;
+
+export type { CommitEnumItemProps, CommitTypeProps, CommitTypesEnum, DefaultCommitTypeKeys };

package/dist/types/commit-types.d.ts

@@ -0,0 +1,19 @@
+import { COMMIT_TYPES } from '../commit-types.js';
+
+type CommitEnumItemProps = {
+    description: string;
+    title?: string;
+    emoji?: string;
+    hidden?: boolean;
+};
+type CommitTypeProps = CommitEnumItemProps & {
+    semverBump: "none" | "patch" | "minor" | "major";
+    changelog: {
+        title: string;
+        hidden: boolean;
+    };
+};
+type DefaultCommitTypeKeys = keyof typeof COMMIT_TYPES;
+type CommitTypesEnum<TCommitTypes extends DefaultCommitTypeKeys = DefaultCommitTypeKeys> = Record<TCommitTypes, CommitTypeProps>;
+
+export type { CommitEnumItemProps, CommitTypeProps, CommitTypesEnum, DefaultCommitTypeKeys };

package/dist/types/commit-types.js

@@ -0,0 +1 @@
+

package/dist/types/config.cjs

@@ -0,0 +1,5 @@
+'use strict';
+
+require('../chunk-SPHHWYOU.cjs');
+require('../chunk-RR5776TG.cjs');
+

package/dist/types/config.d.cts

@@ -0,0 +1,67 @@
+import { StormWorkspaceConfig } from '@storm-software/config/types';
+
+type ChangelogCommitType = Record<string, {
+    type: string;
+    title: string;
+    hidden: boolean | undefined;
+}>;
+interface ChangelogCommitGroupType {
+    type: string;
+    section: string;
+    hidden?: boolean;
+}
+interface PresetConfig {
+    ignoreCommits?: string[];
+    issuePrefixes?: string[];
+    types?: ChangelogCommitType;
+    bumpStrict?: boolean;
+    scope?: string | string[];
+    issueUrlFormat?: string;
+    preMajor?: boolean;
+    formatDate?: (date: string | Date) => string;
+}
+interface ResolvedPresetOptions {
+    workspace: StormWorkspaceConfig;
+    ignoreCommits?: string[];
+    issuePrefixes: string[];
+    types: ChangelogCommitType;
+    bumpStrict: boolean;
+    scope?: string | string[];
+    issueUrlFormat: string;
+    commitUrlFormat: string;
+    compareUrlFormat: string;
+    userUrlFormat: string;
+    preMajor: boolean;
+    formatDate: (date: string | Date) => string;
+}
+interface CommitsConfig {
+    ignore?: string[];
+    merges: boolean;
+}
+type WhatBumpFunction = (commits: {
+    type: string;
+    scope?: string | undefined;
+    notes: {
+        title: string;
+    }[];
+}[]) => {
+    level: number;
+    reason: string;
+} | null;
+interface WhatBumpConfig {
+    types: ChangelogCommitType;
+    bumpStrict?: boolean;
+}
+interface ParserConfig {
+    headerPattern?: RegExp;
+    headerCorrespondence?: string[];
+    breakingHeaderPattern?: RegExp;
+    noteKeywords?: string[];
+    revertPattern?: RegExp;
+    revertCorrespondence?: string[];
+    issuePrefixes?: string[];
+    mergePattern?: RegExp;
+    mergeCorrespondence?: string[];
+}
+
+export type { ChangelogCommitGroupType, ChangelogCommitType, CommitsConfig, ParserConfig, PresetConfig, ResolvedPresetOptions, WhatBumpConfig, WhatBumpFunction };

package/dist/types/config.d.ts

@@ -0,0 +1,67 @@
+import { StormWorkspaceConfig } from '@storm-software/config/types';
+
+type ChangelogCommitType = Record<string, {
+    type: string;
+    title: string;
+    hidden: boolean | undefined;
+}>;
+interface ChangelogCommitGroupType {
+    type: string;
+    section: string;
+    hidden?: boolean;
+}
+interface PresetConfig {
+    ignoreCommits?: string[];
+    issuePrefixes?: string[];
+    types?: ChangelogCommitType;
+    bumpStrict?: boolean;
+    scope?: string | string[];
+    issueUrlFormat?: string;
+    preMajor?: boolean;
+    formatDate?: (date: string | Date) => string;
+}
+interface ResolvedPresetOptions {
+    workspace: StormWorkspaceConfig;
+    ignoreCommits?: string[];
+    issuePrefixes: string[];
+    types: ChangelogCommitType;
+    bumpStrict: boolean;
+    scope?: string | string[];
+    issueUrlFormat: string;
+    commitUrlFormat: string;
+    compareUrlFormat: string;
+    userUrlFormat: string;
+    preMajor: boolean;
+    formatDate: (date: string | Date) => string;
+}
+interface CommitsConfig {
+    ignore?: string[];
+    merges: boolean;
+}
+type WhatBumpFunction = (commits: {
+    type: string;
+    scope?: string | undefined;
+    notes: {
+        title: string;
+    }[];
+}[]) => {
+    level: number;
+    reason: string;
+} | null;
+interface WhatBumpConfig {
+    types: ChangelogCommitType;
+    bumpStrict?: boolean;
+}
+interface ParserConfig {
+    headerPattern?: RegExp;
+    headerCorrespondence?: string[];
+    breakingHeaderPattern?: RegExp;
+    noteKeywords?: string[];
+    revertPattern?: RegExp;
+    revertCorrespondence?: string[];
+    issuePrefixes?: string[];
+    mergePattern?: RegExp;
+    mergeCorrespondence?: string[];
+}
+
+export type { ChangelogCommitGroupType, ChangelogCommitType, CommitsConfig, ParserConfig, PresetConfig, ResolvedPresetOptions, WhatBumpConfig, WhatBumpFunction };

package/dist/types/config.js

@@ -0,0 +1 @@
+import '../chunk-S5TOCB3P.js';

package/dist/types/index.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+require('../chunk-XHJNEOAM.cjs');
+require('../chunk-5GQ7ZUDG.cjs');
+require('../chunk-ZPVHPMDE.cjs');
+require('../chunk-SPHHWYOU.cjs');
+require('../chunk-RR5776TG.cjs');
+

package/dist/types/index.d.cts

@@ -0,0 +1,5 @@
+export { ChangelogCommitGroupType, ChangelogCommitType, CommitsConfig, ParserConfig, PresetConfig, ResolvedPresetOptions, WhatBumpConfig, WhatBumpFunction } from './config.cjs';
+export { ArrayElement } from './misc.cjs';
+export { StormSoftwarePreset } from './preset.cjs';
+export { CommitGroup, CommitKnownProps, CommitNote, CommitNoteGroup, Context, FinalTemplatesOptions, Reference, TemplatesOptions, TransformedCommit, WriteConfig } from './write.cjs';
+import '@storm-software/config/types';

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export { ChangelogCommitGroupType, ChangelogCommitType, CommitsConfig, ParserConfig, PresetConfig, ResolvedPresetOptions, WhatBumpConfig, WhatBumpFunction } from './config.js';
+export { ArrayElement } from './misc.js';
+export { StormSoftwarePreset } from './preset.js';
+export { CommitGroup, CommitKnownProps, CommitNote, CommitNoteGroup, Context, FinalTemplatesOptions, Reference, TemplatesOptions, TransformedCommit, WriteConfig } from './write.js';
+import '@storm-software/config/types';

package/dist/types/index.js

@@ -0,0 +1,4 @@
+import '../chunk-KTGUQC7L.js';
+import '../chunk-3KLR5ZGK.js';
+import '../chunk-UXD2EFE6.js';
+import '../chunk-S5TOCB3P.js';

package/dist/types/misc.cjs

@@ -0,0 +1,5 @@
+'use strict';
+
+require('../chunk-XHJNEOAM.cjs');
+require('../chunk-RR5776TG.cjs');
+

package/dist/types/misc.d.cts

@@ -0,0 +1,3 @@
+type ArrayElement<T> = T extends readonly unknown[] ? T[0] : never;
+
+export type { ArrayElement };

package/dist/types/misc.d.ts

@@ -0,0 +1,3 @@
+type ArrayElement<T> = T extends readonly unknown[] ? T[0] : never;
+
+export type { ArrayElement };

package/dist/types/misc.js

@@ -0,0 +1 @@
+import '../chunk-KTGUQC7L.js';