Skip to content

Commit 56d7863

Browse files
committed
Versioning fixes and prebuilding APIs, temporary disabled minify
1 parent abd2ca8 commit 56d7863

7 files changed

Lines changed: 31 additions & 11 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ node_modules/
55
/build
66
/innercore*-docs.pdf
77
/static/declarations
8+
/api_versioned_docs/version-latest
89

910
# Generated files
1011
.docusaurus

api/docusaurus-plugin/src/index.ts

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -164,17 +164,25 @@ export default function typedocApiPlugin(
164164

165165
// Load info from `package.json`s
166166
packageConfigs.forEach((cfg) => {
167-
const { packageJson } = loadPackageJsonAndDocs(
167+
const packageData = loadPackageJsonAndDocs(
168168
path.join(options.projectRoot, cfg.packagePath),
169169
options.packageJsonName,
170170
options.readmeName,
171171
options.changelogName,
172172
);
173173

174-
// eslint-disable-next-line no-param-reassign
175-
cfg.packageName = packageJson.name;
176-
// eslint-disable-next-line no-param-reassign
177-
cfg.packageVersion = packageJson.version;
174+
if (packageData) {
175+
// eslint-disable-next-line no-param-reassign
176+
cfg.packageName = packageData.packageJson.name;
177+
// eslint-disable-next-line no-param-reassign
178+
cfg.packageVersion = packageData.packageJson.version;
179+
} else {
180+
const packageName = cfg.packageSlug ?? path.basename(cfg.packagePath);
181+
// eslint-disable-next-line no-param-reassign
182+
cfg.packageName = packageName.substring(packageName.lastIndexOf('/') + 1);
183+
// eslint-disable-next-line no-param-reassign
184+
cfg.packageVersion = 'latest';
185+
}
178186
});
179187

180188
await fs.promises.writeFile(

api/docusaurus-plugin/src/plugin/data.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ export function flattenAndGroupPackages(
438438
) ?? {
439439
packageJson: {
440440
name: mod.name.substring(mod.name.lastIndexOf('/') + 1),
441-
version: '1'
441+
version: 'latest'
442442
},
443443
readmePath: '',
444444
changelogPath: ''

api/docusaurus-plugin/src/plugin/version.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ export async function readVersionsMetadata(
9494
disableVersioning: options.disableVersioning ?? false,
9595
id: options.id ?? 'default',
9696
includeCurrentVersion: options.includeCurrentVersion ?? true,
97+
path: (options as any).path ?? options.projectRoot ?? 'api',
9798
});
9899
const versionNames = filterVersions(versionNamesUnfiltered, {
99100
...specialOptions,

api_versions.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
["latest"]

docusaurus.config.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ export default {
114114
[
115115
'@nernar/docusaurus-plugin-typedoc',
116116
{
117+
id: 'api',
117118
projectRoot: 'api',
118119
packageJsonName: 'typedoc.json',
119120
sortPackages: (left, right) =>
@@ -158,7 +159,14 @@ export default {
158159
// TODO: Page groups like in typedoc-github-theme.
159160
// ]
160161
},
161-
remarkPlugins: [remarkAuthors]
162+
remarkPlugins: [remarkAuthors],
163+
includeCurrentVersion: false,
164+
lastVersion: 'latest',
165+
versions: {
166+
latest: {
167+
path: ''
168+
}
169+
}
162170
} satisfies Typedoc.Options
163171
]
164172
],

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
"scripts": {
2525
"start": "docusaurus start --no-open --no-minify",
2626
"start-ru": "docusaurus start --locale ru --no-open --no-minify",
27-
"build-docs": "docusaurus build",
28-
"build-docs-ci": "node --max-old-space-size=6144 ./node_modules/.bin/docusaurus build",
29-
"build": "npm run prebuild-plugin && npm run prebuild-declarations && npm run build-docs",
30-
"build-ci": "npm run prebuild-plugin && npm run prebuild-declarations && npm run build-docs-ci",
27+
"build-docs": "docusaurus build --no-minify",
28+
"build-docs-ci": "node --max-old-space-size=6144 ./node_modules/.bin/docusaurus build --no-minify",
29+
"build": "npm run prebuild-plugin && npm run prebuild-declarations && npm run prebuild-api && npm run build-docs",
30+
"build-ci": "npm run prebuild-plugin && npm run prebuild-declarations && npm run prebuild-api && npm run build-docs-ci",
3131
"serve": "docusaurus serve --no-open",
3232
"build-serve": "npm run build && npm run serve",
3333
"write-translations": "docusaurus write-translations --locale ru",
@@ -36,6 +36,7 @@
3636
"clear": "docusaurus clear",
3737
"prebuild-declarations": "npx dts-generator --project api/core-engine --out static/declarations/core-engine.d.ts --extern ./android.d.ts --exclude **/node_modules/**/*.d.ts --exclude **/declarations/android.d.ts",
3838
"prebuild-plugin": "npm run --prefix api/docusaurus-plugin build",
39+
"prebuild-api": "docusaurus api:version:api latest",
3940
"deploy-pdf": "tsx tools/generate-pdf.ts --initialDocURLs=https://nernar.github.io/docs/intro --outputPDFFilename=innercore-docs.pdf --excludeSelectors=\".margin-vert--xl a\"",
4041
"deploy-pdf-ru": "tsx tools/generate-pdf.ts --initialDocURLs=https://nernar.github.io/ru/docs/intro --outputPDFFilename=innercore-russian-docs.pdf --excludeSelectors=\".margin-vert--xl a\"",
4142
"deploy-libraries-pdf": "tsx tools/generate-pdf.ts --initialDocURLs=https://nernar.github.io/libraries/BackpackAPI --outputPDFFilename=innercore-libraries-docs.pdf --excludeSelectors=\".margin-vert--xl a\"",

0 commit comments

Comments
 (0)