Skip to content

Allow generation of docs from pre-release versions #143

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.

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
merged 2 commits into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions generate-local.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ function exit() {
}

function semverVersion(value) {
if (!/^\d+\.\d+\.\d+$/.test(value)) {
throw new InvalidArgumentError('Not a correctly defined semver version i.e. major.minor.patch');
if (!/^\d+\.\d+\.\d+(-[0-9A-Za-z-.]+)?$/.test(value)) {
throw new InvalidArgumentError(
'Not a correctly defined semver version i.e. major.minor.patch or with prerelease',
);
}
return value;
}
Expand Down
6 changes: 4 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import { program, Option, InvalidArgumentError } from 'commander';
import chalk from 'chalk';

function semverVersion(value) {
if (!/^\d+\.\d+\.\d+$/.test(value)) {
throw new InvalidArgumentError('Not a correctly defined semver version i.e. major.minor.patch');
if (!/^\d+\.\d+\.\d+(-[0-9A-Za-z-.]+)?$/.test(value)) {
throw new InvalidArgumentError(
'Not a correctly defined semver version i.e. major.minor.patch or with prerelease',
);
}
return value;
}
Expand Down
9 changes: 4 additions & 5 deletions lib/get-latest-patch-versions.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { groupBy } from 'lodash-es';
import semverCompare from 'semver-compare';
import semverUtils from 'semver-utils';
import semver from 'semver';

export function getLatestPatchVersions(versions) {
let groupedVersions = groupBy(
versions.sort(semverCompare).map(semverUtils.parse),
v => `${v.major}.${v.minor}`,
versions.sort((a, b) => semver.rcompare(a, b)),
v => `${semver.major(v)}.${semver.minor(v)}`,
);
return Object.values(groupedVersions).map(verGroup => verGroup.pop().version);
return Object.values(groupedVersions).map(verGroup => verGroup[0]);
}
8 changes: 4 additions & 4 deletions lib/normalize-ids.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ function extractRelationship({ id, type }) {
return { id, type };
}

function filterForVersion(version) {
function filterForVersion(project, version) {
return ({ relationships }) => {
const projectVersion = relationships['project-version'].data.id.split('-').pop();
const projectVersion = relationships['project-version'].data.id.replace(`${project}-`, '');
return version.version === projectVersion;
};
}
Expand Down Expand Up @@ -56,7 +56,7 @@ async function normalizeIDs(pVersions, projectName) {

let projectVersions = pVersions.map(version => {
let classes = findType(jsonapidoc, 'class')
.filter(filterForVersion(version))
.filter(filterForVersion(projectName, version))
.filter(removeLongDocsBecauseEmber1HasWeirdDocs);

let namespaces = classes.filter(({ attributes }) => attributes.static === 1);
Expand All @@ -67,7 +67,7 @@ async function normalizeIDs(pVersions, projectName) {
namespaces.forEach(ns => (ns.type = 'namespace'));

let modules = findType(jsonapidoc, 'module')
.filter(filterForVersion(version))
.filter(filterForVersion(projectName, version))
.filter(curry(filter176)(projectName, version.version));

return {
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
"semver-compare": "^1.0.0",
"semver-extra": "^3.0.0",
"semver-utils": "^1.1.4",
"yuidoc-to-jsonapi": "^0.4.1"
"yuidoc-to-jsonapi": "^0.4.1",
"semver": "^7.7.2"
},
"devDependencies": {
"chai": "^4.2.0",
Expand Down
15 changes: 9 additions & 6 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.