Skip to content

Commit 280eb12

Browse files
authored
docs: use major node version in placeholders (#1296)
## 🧰 Changes i noticed that our docs are displaying an improper node.js version range on the docker image examples — i fixed it up here: https://github.com/readmeio/docs-developers/compare/5b0fe7c01d74d5732070cd731eb42b6b92bcb17d...8f77f008b62555178ab1f405429dddb88ee69dd4 this PR ensures this remains correct.
1 parent 9888212 commit 280eb12

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

__tests__/lib/getPkgVersion.test.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
import nock from 'nock';
2-
import semver from 'semver';
32
import { describe, beforeEach, afterEach, it, expect, vi, type MockInstance } from 'vitest';
43

54
import pkg from '../../package.json' with { type: 'json' };
65
import { getNodeVersion, getPkgVersion, getPkgVersionFromNPM } from '../../src/lib/getPkg.js';
76

87
describe('#getNodeVersion()', () => {
9-
it('should extract version that matches range in package.json', () => {
8+
it('should return a major version', () => {
109
const version = getNodeVersion();
11-
const cleanedVersion = semver.valid(semver.coerce(version));
1210

13-
expect(semver.satisfies(cleanedVersion as string, pkg.engines.node)).toBe(true);
11+
expect(version).toHaveLength(2);
1412
});
1513
});
1614

src/lib/getPkg.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export function getNodeVersion(): string {
2424
if (!parsedVersion) {
2525
throw new Error('`version` value in package.json is invalid');
2626
}
27-
return parsedVersion.version;
27+
return parsedVersion.major.toString();
2828
}
2929

3030
/**

0 commit comments

Comments
 (0)