Skip to content

Fix TOML path targeting and formatting loss with toml-patch #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
webpro merged 4 commits into from
May 23, 2026
Merged

Fix TOML path targeting and formatting loss with toml-patch #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b8d2cf
test: add tests demonstrating limitations of the toml regex edit
JamesMBarr May 16, 2026
e7e943d
fix(toml): adhere to target path when patching toml formatted files
JamesMBarr May 16, 2026
392a19d
test: refactor toml tests to align more with json tests
JamesMBarr May 16, 2026
9760ee9
test: refactor toml test to reduce boilerplate
JamesMBarr May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { castArray, get, set } from 'lodash-es';
import detectIndent from 'detect-indent';
import yaml from 'js-yaml';
import toml from '@iarna/toml';
import { patch } from '@decimalturn/toml-patch';
import ini from 'ini';
import semver from 'semver';
import { Plugin } from 'release-it';
Expand Down Expand Up @@ -182,15 +183,8 @@ class Bumper extends Plugin {
case 'yaml':
return writeFileSync(file, yaml.dump(parsed, { indent: indent.length }));
case 'toml':
var tomlContent = data;

castArray(path).forEach(path => {
const latestPath = path.split('.').at(-1);
const versionMatch = new RegExp(`${latestPath}[\\W\\w]+?(${latestVersion.replaceAll('.', '\\.')})` || '');
tomlContent = tomlContent.replace(versionMatch, (match, group1) => {
return match.replace(group1, versionPrefix + version);
});
});
let tomlContent = data
tomlContent = patch(tomlContent, parsed)

return writeFileSync(file, tomlContent.replace(/(\r?\n)/g, newline));
case 'ini':
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
},
"author": "Lars Kappert <lars@webpro.nl>",
"dependencies": {
"@decimalturn/toml-patch": "^1.3.0",
"@iarna/toml": "^3.0.0",
"cheerio": "^1.0.0",
"detect-indent": "7.0.1",
Expand Down
149 changes: 98 additions & 51 deletions test/toml.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,27 @@ import { readFile } from './globals/file-utils.js';

mock({
'./foo.toml': `[tool.test]${EOL}version = "${CURRENT_VERSION}"${EOL}`,
// includes another section with a "version" key with semver value
'./without_target_version.toml': `[tool.test]${EOL}[tool.ignored]${EOL}version = "${CURRENT_VERSION}"${EOL}`,
'./with_multiple_version.toml': `[tool.test]${EOL}[project]${EOL}`,
'./with_comments_and_formatting.toml': `# Lead with some comments${EOL}${EOL}[workspace]${EOL}${EOL}${EOL}[tool.test]${EOL}name = "hello_world"${EOL}version = "${CURRENT_VERSION}"${EOL}`,
// project version is already at NEW_VERSION and has a dependency with a version containing the CURRENT_VERSION
'./at_current_version.toml': `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}dependencies = [${EOL} "django = 1${CURRENT_VERSION}"${EOL}]${EOL}`,
'./cargo.toml': `[workspace]${EOL}${EOL}[package]${EOL}name = "hello_world"${EOL}version = "${CURRENT_VERSION}"${EOL}authors = [ "Alice <a@example.com>", "Bob <b@example.com>" ]${EOL}${EOL}[dependencies]${EOL}time = "0.1.12"${EOL}`,
'./pyproject.toml': `[project]${EOL}name = "foo"${EOL}version = "${CURRENT_VERSION}"${EOL}# these are authors${EOL}authors = [{ name = "Alice", email = "a@example.com" }]${EOL}`
'./pyproject.toml': `[project]${EOL}name = "foo"${EOL}version = "${CURRENT_VERSION}"${EOL}authors = [{ name = "Alice", email = "a@example.com" }]${EOL}dependencies = [${EOL} "django = 1${CURRENT_VERSION}"${EOL}]${EOL}[tool.commitizen]${EOL}version = "${CURRENT_VERSION}"${EOL}`,
});

const readFilePostBumperTasks = async (namespaceOptions) => {
const options = {
[NAMESPACE]: namespaceOptions
}

const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);

return readFile(namespaceOptions.out.file)
}

describe('toml file', { concurrency: true }, () => {
it('should return latest version', async () => {
const options = {
Expand All @@ -24,80 +41,110 @@ describe('toml file', { concurrency: true }, () => {
assert.equal(version, CURRENT_VERSION);
});

it('should write', async () => {
const options = {
[NAMESPACE]: {
out: {
file: './foo.toml',
type: 'text/toml',
path: 'tool.test.version'
}
it('should add version at path when missing', async () => {
const namespaceOptions = {
out: {
file: './without_target_version.toml',
type: 'text/toml',
path: 'tool.test.version'
}
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
assert.equal(readFile('./foo.toml'), `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
const contents = await readFilePostBumperTasks(namespaceOptions)
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}[tool.ignored]${EOL}version = "${CURRENT_VERSION}"${EOL}`);
});

it('should update version at path', async () => {
const namespaceOptions = {
out: {
file: './foo.toml',
type: 'text/toml',
path: 'tool.test.version'
}
};
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
});

it('should update versions at multiple paths', async () => {
const namespaceOptions = {
out: {
file: './with_multiple_version.toml',
type: 'text/toml',
path: ['project.version', 'tool.test.version']
}
};
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}[project]${EOL}version = "${NEW_VERSION}"${EOL}`);
});

it('should write without defining the type', async () => {
const options = {
[NAMESPACE]: { out: { file: './foo.toml', path: 'tool.test.version' } }
const namespaceOptions = {
out: { file: './foo.toml', path: 'tool.test.version' }
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
assert.equal(readFile('./foo.toml'), `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
});

it('should read/write', async () => {
const options = {
[NAMESPACE]: {
in: { file: './foo.toml', type: 'application/toml', path: 'tool.test.version' },
out: { file: './foo.toml', type: 'application/toml', path: 'tool.test.version' }
}
const namespaceOptions = {
in: { file: './foo.toml', type: 'application/toml', path: 'tool.test.version' },
out: { file: './foo.toml', type: 'application/toml', path: 'tool.test.version' }
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
assert.equal(readFile('./foo.toml'), `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
});

it('should read/write without defining the type', async () => {
const options = {
[NAMESPACE]: {
in: { file: './foo.toml', path: 'tool.test.version' },
out: { file: './foo.toml', path: 'tool.test.version' }
}
const namespaceOptions = {
in: { file: './foo.toml', path: 'tool.test.version' },
out: { file: './foo.toml', path: 'tool.test.version' }
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
assert.equal(readFile('./foo.toml'), `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(contents, `[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}`);
});

it('should read/write without formatting', async () => {
const options = {
[NAMESPACE]: {
in: { file: './cargo.toml', path: 'package.version' },
out: { file: './cargo.toml', path: 'package.version' }
}
const namespaceOptions = {
in: { file: './with_comments_and_formatting.toml', path: 'tool.test.version' },
out: { file: './with_comments_and_formatting.toml', path: 'tool.test.version' }
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(
contents,
`# Lead with some comments${EOL}${EOL}[workspace]${EOL}${EOL}${EOL}[tool.test]${EOL}name = "hello_world"${EOL}version = "${NEW_VERSION}"${EOL}`
);
});

it('should noop when the target version is already at the new version', async () => {
const namespaceOptions = {
out: { file: './at_current_version.toml', path: 'tool.test.version' }
};
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(
readFile('./cargo.toml'),
contents,
`[tool.test]${EOL}version = "${NEW_VERSION}"${EOL}dependencies = [${EOL} "django = 1${CURRENT_VERSION}"${EOL}]${EOL}`
);
});

it('should handle example cargo.toml file', async () => {
const namespaceOptions = {
out: { file: './cargo.toml', path: 'package.version' }
};
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(
contents,
`[workspace]${EOL}${EOL}[package]${EOL}name = "hello_world"${EOL}version = "${NEW_VERSION}"${EOL}authors = [ "Alice <a@example.com>", "Bob <b@example.com>" ]${EOL}${EOL}[dependencies]${EOL}time = "0.1.12"${EOL}`
);
});

it('should read/write minimal changes', async () => {
const options = {
[NAMESPACE]: {
out: { file: './pyproject.toml', path: 'project.version' }
}
it('should handle example pyproject.toml file', async () => {
const namespaceOptions = {
out: { file: './pyproject.toml', path: 'project.version' }
};
const plugin = await factory(Bumper, { NAMESPACE, options });
await runTasks(plugin);
const contents = await readFilePostBumperTasks(namespaceOptions);
assert.equal(
readFile('./pyproject.toml'),
`[project]${EOL}name = "foo"${EOL}version = "${NEW_VERSION}"${EOL}# these are authors${EOL}authors = [{ name = "Alice", email = "a@example.com" }]${EOL}`
contents,
`[project]${EOL}name = "foo"${EOL}version = "${NEW_VERSION}"${EOL}authors = [{ name = "Alice", email = "a@example.com" }]${EOL}dependencies = [${EOL} "django = 1${CURRENT_VERSION}"${EOL}]${EOL}[tool.commitizen]${EOL}version = "${CURRENT_VERSION}"${EOL}`
);
});
});
});
Loading