@monoweave/changelog 1.20.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/changelog.js CHANGED
@@ -1,24 +1,18 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.generateChangelogEntry = void 0;
7
- const stream_1 = require("stream");
8
- const git_1 = require("@monoweave/git");
9
- const io_1 = require("@monoweave/io");
10
- const core_1 = require("@yarnpkg/core");
11
- const conventional_changelog_writer_1 = __importDefault(require("conventional-changelog-writer"));
12
- const conventional_commits_parser_1 = __importDefault(require("conventional-commits-parser"));
13
- const defaultChangelogWriter_1 = require("./defaultChangelogWriter");
14
- const resolveConventionalConfig_1 = __importDefault(require("./resolveConventionalConfig"));
15
- const generateChangelogEntry = async ({ config, context, packageName, previousVersion, newVersion, commits, }) => {
1
+ import { Readable } from 'stream';
2
+ import { parseRepositoryProperty } from '@monoweave/git';
3
+ import { readStream, readStreamString } from '@monoweave/io';
4
+ import { structUtils } from '@yarnpkg/core';
5
+ import conventionalChangelogWriter from 'conventional-changelog-writer';
6
+ import conventionalCommitsParser from 'conventional-commits-parser';
7
+ import { defaultChangelogWriter } from './defaultChangelogWriter.js';
8
+ import resolveConventionalConfig from './resolveConventionalConfig.js';
9
+ export const generateChangelogEntry = async ({ config, context, packageName, previousVersion, newVersion, commits, }) => {
16
10
  if (!commits.length) {
17
11
  return null;
18
12
  }
19
- const ident = core_1.structUtils.parseIdent(packageName);
13
+ const ident = structUtils.parseIdent(packageName);
20
14
  const workspace = context.project.getWorkspaceByIdent(ident);
21
- const { host, owner, repository, repoUrl } = await (0, git_1.parseRepositoryProperty)(workspace);
15
+ const { host, owner, repository, repoUrl } = await parseRepositoryProperty(workspace);
22
16
  const templateContext = {
23
17
  version: newVersion,
24
18
  title: packageName,
@@ -31,15 +25,15 @@ const generateChangelogEntry = async ({ config, context, packageName, previousVe
31
25
  linkCompare: Boolean(previousVersion),
32
26
  };
33
27
  if (!config.conventionalChangelogConfig) {
34
- return await (0, defaultChangelogWriter_1.defaultChangelogWriter)({
28
+ return await defaultChangelogWriter({
35
29
  commits,
36
30
  templateContext,
37
31
  });
38
32
  }
39
- const conventionalConfig = await (0, resolveConventionalConfig_1.default)({ config });
40
- const commitsStream = stream_1.Readable.from(commits.map((commit) => `${commit.body}\n-hash-\n${commit.sha}`)).pipe((0, conventional_commits_parser_1.default)(conventionalConfig.parserOpts));
41
- const conventionalCommits = await (0, io_1.readStream)(commitsStream);
42
- const changelogWriter = (0, conventional_changelog_writer_1.default)(templateContext, conventionalConfig.writerOpts);
33
+ const conventionalConfig = await resolveConventionalConfig({ config });
34
+ const commitsStream = Readable.from(commits.map((commit) => `${commit.body}\n-hash-\n${commit.sha}`)).pipe(conventionalCommitsParser(conventionalConfig.parserOpts));
35
+ const conventionalCommits = await readStream(commitsStream);
36
+ const changelogWriter = conventionalChangelogWriter(templateContext, conventionalConfig.writerOpts);
43
37
  async function* transformedCommits() {
44
38
  for (const commit of conventionalCommits) {
45
39
  // NOTE: This mutates the commit.
@@ -50,7 +44,6 @@ const generateChangelogEntry = async ({ config, context, packageName, previousVe
50
44
  yield mutableCommit;
51
45
  }
52
46
  }
53
- const pipeline = stream_1.Readable.from(transformedCommits()).pipe(changelogWriter);
54
- return (0, io_1.readStreamString)(pipeline);
47
+ const pipeline = Readable.from(transformedCommits()).pipe(changelogWriter);
48
+ return readStreamString(pipeline);
55
49
  };
56
- exports.generateChangelogEntry = generateChangelogEntry;
@@ -1,5 +1,5 @@
1
1
  import type { CommitMessage } from '@monoweave/types';
2
- import { type TemplateContext } from './types';
2
+ import { type TemplateContext } from './types.js';
3
3
  /**
4
4
  * Simple changelog entry writer if no conventional changelog config is provided.
5
5
  * It is recommended to use a conventional changelog where possible (they'll handle more edge cases).
@@ -1,11 +1,8 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.defaultChangelogWriter = defaultChangelogWriter;
4
1
  /**
5
2
  * Simple changelog entry writer if no conventional changelog config is provided.
6
3
  * It is recommended to use a conventional changelog where possible (they'll handle more edge cases).
7
4
  */
8
- async function defaultChangelogWriter({ commits, templateContext: { currentTag, host, owner, previousTag, repoUrl, repository, title, version }, }) {
5
+ export async function defaultChangelogWriter({ commits, templateContext: { currentTag, host, owner, previousTag, repoUrl, repository, title, version }, }) {
9
6
  const headerPattern = /^(\w*)(?:\((.*)\))?: (.*)$/;
10
7
  const notePattern = /^(revert|note|breaking change):\s/i;
11
8
  const dateString = new Date().toLocaleDateString();
package/lib/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { generateChangelogEntry } from './changelog';
2
- import prependChangelogFile from './prependChangelogFile';
3
- import resolveConventionalConfig from './resolveConventionalConfig';
1
+ import { generateChangelogEntry } from './changelog.js';
2
+ import prependChangelogFile from './prependChangelogFile.js';
3
+ import resolveConventionalConfig from './resolveConventionalConfig.js';
4
4
  export { prependChangelogFile, resolveConventionalConfig, generateChangelogEntry };
package/lib/index.js CHANGED
@@ -1,12 +1,4 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.generateChangelogEntry = exports.resolveConventionalConfig = exports.prependChangelogFile = void 0;
7
- const changelog_1 = require("./changelog");
8
- Object.defineProperty(exports, "generateChangelogEntry", { enumerable: true, get: function () { return changelog_1.generateChangelogEntry; } });
9
- const prependChangelogFile_1 = __importDefault(require("./prependChangelogFile"));
10
- exports.prependChangelogFile = prependChangelogFile_1.default;
11
- const resolveConventionalConfig_1 = __importDefault(require("./resolveConventionalConfig"));
12
- exports.resolveConventionalConfig = resolveConventionalConfig_1.default;
1
+ import { generateChangelogEntry } from './changelog.js';
2
+ import prependChangelogFile from './prependChangelogFile.js';
3
+ import resolveConventionalConfig from './resolveConventionalConfig.js';
4
+ export { prependChangelogFile, resolveConventionalConfig, generateChangelogEntry };
@@ -1,32 +1,27 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const fs_1 = require("fs");
7
- const path_1 = __importDefault(require("path"));
8
- const git_1 = require("@monoweave/git");
9
- const logging_1 = __importDefault(require("@monoweave/logging"));
10
- const types_1 = require("@monoweave/types");
11
- const core_1 = require("@yarnpkg/core");
12
- const fslib_1 = require("@yarnpkg/fslib");
1
+ import { promises as fs } from 'fs';
2
+ import path from 'path';
3
+ import { gitCheckout } from '@monoweave/git';
4
+ import logging from '@monoweave/logging';
5
+ import { isNodeError, } from '@monoweave/types';
6
+ import { structUtils } from '@yarnpkg/core';
7
+ import { npath } from '@yarnpkg/fslib';
13
8
  const LEGACY_MARKER = '<!-- MONODEPLOY:BELOW -->';
14
9
  const MARKER = '<!-- MONOWEAVE:BELOW -->';
15
10
  const TOKEN_PACKAGE_DIR = '<packageDir>';
16
11
  const prependEntry = async ({ config, context, filename, entry, }) => {
17
12
  let changelogContents = [];
18
13
  try {
19
- changelogContents = (await fs_1.promises.readFile(filename, { encoding: 'utf-8' })).split('\n');
14
+ changelogContents = (await fs.readFile(filename, { encoding: 'utf-8' })).split('\n');
20
15
  }
21
16
  catch (err) {
22
- if ((0, types_1.isNodeError)(err) && err.code === 'ENOENT') {
23
- logging_1.default.info(`[Changelog] Changelog ${filename} does not exist, creating.`, {
17
+ if (isNodeError(err) && err.code === 'ENOENT') {
18
+ logging.info(`[Changelog] Changelog ${filename} does not exist, creating.`, {
24
19
  report: context.report,
25
20
  });
26
21
  changelogContents = ['# Changelog', '', MARKER];
27
22
  }
28
23
  else {
29
- logging_1.default.error(`[Changelog] Unable to read changelog contents at ${filename}.`, {
24
+ logging.error(`[Changelog] Unable to read changelog contents at ${filename}.`, {
30
25
  report: context.report,
31
26
  });
32
27
  throw err;
@@ -34,14 +29,14 @@ const prependEntry = async ({ config, context, filename, entry, }) => {
34
29
  }
35
30
  const changelogOffset = changelogContents.findIndex((value) => [MARKER, LEGACY_MARKER].includes(value.trim()));
36
31
  if (changelogOffset === -1) {
37
- logging_1.default.error(`[Changelog] Missing changelog marker: '${MARKER}'`, {
32
+ logging.error(`[Changelog] Missing changelog marker: '${MARKER}'`, {
38
33
  report: context.report,
39
34
  });
40
35
  throw new Error('Unable to prepend changelog.');
41
36
  }
42
37
  // Legacy marker cleanup
43
38
  if (changelogContents[changelogOffset].includes(LEGACY_MARKER)) {
44
- logging_1.default.warning(`[Changelog] Upgrading '${LEGACY_MARKER}' to '${MARKER}'`, {
39
+ logging.warning(`[Changelog] Upgrading '${LEGACY_MARKER}' to '${MARKER}'`, {
45
40
  report: context.report,
46
41
  });
47
42
  changelogContents[changelogOffset] = changelogContents[changelogOffset].replace(LEGACY_MARKER, MARKER);
@@ -49,16 +44,16 @@ const prependEntry = async ({ config, context, filename, entry, }) => {
49
44
  changelogContents.splice(changelogOffset + 1, 0, `\n${entry}\n`);
50
45
  const dataToWrite = changelogContents.join('\n');
51
46
  if (config.dryRun && !config.forceWriteChangeFiles) {
52
- logging_1.default.debug('[Changelog] Skipping changelog update.', {
47
+ logging.debug('[Changelog] Skipping changelog update.', {
53
48
  report: context.report,
54
49
  });
55
50
  }
56
51
  else {
57
- await fs_1.promises.writeFile(filename, dataToWrite, {
52
+ await fs.writeFile(filename, dataToWrite, {
58
53
  encoding: 'utf-8',
59
54
  });
60
55
  }
61
- logging_1.default.info(`[Changelog] Updated ${filename}`, {
56
+ logging.info(`[Changelog] Updated ${filename}`, {
62
57
  report: context.report,
63
58
  });
64
59
  };
@@ -71,10 +66,10 @@ const prependChangelogFile = async ({ config, context, changeset, workspaces, fo
71
66
  const changelogGlob = config.changelogFilename.replace('<packageDir>', '**');
72
67
  if (changelogGlob) {
73
68
  try {
74
- await (0, git_1.gitCheckout)({ files: [changelogGlob] }, { cwd: config.cwd, context, remote: config.git.remote });
69
+ await gitCheckout({ files: [changelogGlob] }, { cwd: config.cwd, context, remote: config.git.remote });
75
70
  }
76
71
  catch {
77
- logging_1.default.debug('Force refreshing changelogs failed. Ignoring.', {
72
+ logging.debug('Force refreshing changelogs failed. Ignoring.', {
78
73
  report: context.report,
79
74
  });
80
75
  }
@@ -82,8 +77,8 @@ const prependChangelogFile = async ({ config, context, changeset, workspaces, fo
82
77
  }
83
78
  if (config.changelogFilename.includes(TOKEN_PACKAGE_DIR)) {
84
79
  const prependForWorkspace = async (workspace) => {
85
- const filename = fslib_1.npath.fromPortablePath(config.changelogFilename.replace(TOKEN_PACKAGE_DIR, fslib_1.npath.fromPortablePath(workspace.cwd)));
86
- const packageName = core_1.structUtils.stringifyIdent(workspace.manifest.name);
80
+ const filename = npath.fromPortablePath(config.changelogFilename.replace(TOKEN_PACKAGE_DIR, npath.fromPortablePath(workspace.cwd)));
81
+ const packageName = structUtils.stringifyIdent(workspace.manifest.name);
87
82
  const entry = changeset[packageName]?.changelog;
88
83
  if (entry)
89
84
  await prependEntry({ config, context, filename, entry });
@@ -92,7 +87,7 @@ const prependChangelogFile = async ({ config, context, changeset, workspaces, fo
92
87
  await Promise.all([...workspaces].map((workspace) => limit(() => prependForWorkspace(workspace))));
93
88
  return;
94
89
  }
95
- const filename = path_1.default.resolve(config.cwd, config.changelogFilename);
90
+ const filename = path.resolve(config.cwd, config.changelogFilename);
96
91
  const entry = Object.entries(changeset)
97
92
  .sort(([pkgNameA], [pkgNameB]) => pkgNameA.localeCompare(pkgNameB))
98
93
  .map(([, changesetValue]) => changesetValue.changelog)
@@ -102,4 +97,4 @@ const prependChangelogFile = async ({ config, context, changeset, workspaces, fo
102
97
  if (entry)
103
98
  await prependEntry({ config, context, filename, entry });
104
99
  };
105
- exports.default = prependChangelogFile;
100
+ export default prependChangelogFile;
@@ -1,5 +1,5 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ import { createRequire } from 'node:module';
2
+ import { npath } from '@yarnpkg/fslib';
3
3
  const coerceConventionalConfig = (config) => {
4
4
  if (typeof config === 'string') {
5
5
  return {
@@ -14,12 +14,10 @@ const resolveConventionalConfig = async ({ config, }) => {
14
14
  throw new Error('No conventional changelog config provided');
15
15
  }
16
16
  const conventionalConfig = coerceConventionalConfig(conventionalChangelogConfig);
17
- // ghost-imports-ignore-next-line
18
- const conventionalConfigModule = require(require.resolve(conventionalConfig.name, {
19
- paths: [config.cwd],
20
- }));
17
+ const nCwd = npath.join(npath.fromPortablePath(config.cwd), 'package.json');
18
+ const conventionalConfigModule = createRequire(nCwd)(conventionalConfig.name);
21
19
  return await (typeof conventionalConfigModule === 'function'
22
20
  ? conventionalConfigModule(conventionalConfig)
23
21
  : conventionalConfigModule);
24
22
  };
25
- exports.default = resolveConventionalConfig;
23
+ export default resolveConventionalConfig;
package/lib/types.js CHANGED
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@monoweave/changelog",
3
- "version": "1.20.1",
3
+ "version": "2.1.0",
4
+ "type": "module",
4
5
  "repository": {
5
6
  "type": "git",
6
7
  "url": "https://github.com/monoweave/monoweave.git",
@@ -30,32 +31,32 @@
30
31
  "prepack": "run workspace:build \"$(pwd)\""
31
32
  },
32
33
  "peerDependencies": {
33
- "@monoweave/git": "^1.20.0",
34
- "@monoweave/io": "^1.20.0",
35
- "@monoweave/logging": "^1.20.0",
36
- "@monoweave/types": "^1.20.0",
37
- "@yarnpkg/core": "^4.4.4",
38
- "@yarnpkg/fslib": "^3.1.3",
34
+ "@monoweave/git": "^2.1.0",
35
+ "@monoweave/io": "^2.1.0",
36
+ "@monoweave/logging": "^2.1.0",
37
+ "@monoweave/types": "^2.1.0",
38
+ "@yarnpkg/core": "^4.5.0",
39
+ "@yarnpkg/fslib": "^3.1.4",
39
40
  "@yarnpkg/shell": "^4.1.3"
40
41
  },
41
42
  "dependencies": {
42
43
  "conventional-changelog-writer": "^7.0.1",
43
44
  "conventional-commits-parser": "^5.0.0",
44
- "p-limit": "^6.2.0"
45
+ "p-limit": "^7.2.0"
45
46
  },
46
47
  "devDependencies": {
47
- "@jest/globals": "^30.0.0-alpha.6",
48
- "@monoweave/git": "1.20.1",
49
- "@monoweave/io": "1.20.0",
50
- "@monoweave/logging": "1.20.0",
51
- "@monoweave/test-utils": "link:../../testUtils",
52
- "@monoweave/types": "1.20.0",
53
- "@types/conventional-changelog-writer": "^4.0.10",
54
- "@types/conventional-commits-parser": "^5.0.1",
55
- "@types/node": "^22.10.5",
56
- "@yarnpkg/core": "^4.4.4",
57
- "@yarnpkg/fslib": "^3.1.3",
58
- "@yarnpkg/shell": "^4.1.3"
48
+ "@monoweave/git": "2.1.0",
49
+ "@monoweave/io": "2.1.0",
50
+ "@monoweave/logging": "2.1.0",
51
+ "@monoweave/test-utils": "0.0.0",
52
+ "@monoweave/types": "2.1.0",
53
+ "@types/conventional-changelog-writer": "^4.0.11",
54
+ "@types/conventional-commits-parser": "^5.0.2",
55
+ "@types/node": "^22.18.13",
56
+ "@yarnpkg/core": "^4.5.0",
57
+ "@yarnpkg/fslib": "^3.1.4",
58
+ "@yarnpkg/shell": "^4.1.3",
59
+ "vitest": "^3.2.4"
59
60
  },
60
61
  "types": "./lib/index.d.ts"
61
62
  }