@versatiles/release-tool 2.2.3 → 2.3.0

package/README.md

@@ -53,7 +53,7 @@ Options:
   -h, --help                                display help for command
 
 Commands:
-  check-package                             Check package.json for required scripts and other metadata.
+  check                                     Check repo for required scripts and other stuff.
   deps-graph                                Analyze project files and output a dependency graph as Mermaid markup.
   deps-upgrade                              Upgrade all dependencies in the current project to their latest versions.
   doc-command <command>                     Generate Markdown documentation for a specified command and output the result.
@@ -64,13 +64,13 @@ Commands:
   release-npm [path]                        Publish an npm package from the specified path to the npm registry.
 ```
 
-## Subcommand: `vrt check-package`
+## Subcommand: `vrt check`
 
 ```console
-$ vrt check-package
-Usage: vrt check-package [options]
+$ vrt check
+Usage: vrt check [options]
 
-Check package.json for required scripts and other metadata.
+Check repo for required scripts and other stuff.
 
 Options:
   -h, --help  display help for command
@@ -196,7 +196,7 @@ flowchart TB
 
 subgraph 0["src"]
 subgraph 1["commands"]
-2["check-package.ts"]
+2["check.ts"]
 5["deps-graph.ts"]
 6["deps-upgrade.ts"]
 8["doc-command.ts"]

package/dist/commands/check.d.ts

@@ -0,0 +1,3 @@
+export declare function check(directory: string): void;
+export declare function checkPackage(directory: string): void;
+export declare function checkWorkflow(directory: string): void;

package/dist/commands/{check-package.js → check.js}

@@ -1,6 +1,10 @@
-import { readFileSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { panic, info, warn } from '../lib/log.js';
 import { resolve } from 'node:path';
+export function check(directory) {
+    checkPackage(directory);
+    checkWorkflow(directory);
+}
 export function checkPackage(directory) {
     const pack = JSON.parse(readFileSync(resolve(directory, 'package.json'), 'utf8'));
     const { scripts } = pack;
@@ -12,6 +16,9 @@ export function checkPackage(directory) {
         info('scripts.doc is recommended');
     if (!scripts.build)
         panic('scripts.build is required');
+    if (!scripts.build.includes("npm run doc")) {
+        warn(`scripts.build should include "npm run doc-graph", but is "${scripts.build}"`);
+    }
     if (!scripts.check)
         panic('scripts.check is required');
     if (!scripts.check.includes('npm run build')) {
@@ -50,4 +57,9 @@ export function checkPackage(directory) {
         }
     });
 }
-//# sourceMappingURL=check-package.js.map
+export function checkWorkflow(directory) {
+    if (!existsSync(resolve(directory, '.github/workflows/pages.yml'))) {
+        info('GitHub Pages workflow not found');
+    }
+}
+//# sourceMappingURL=check.js.map

package/dist/commands/doc-typescript.js

@@ -7,7 +7,7 @@ export async function generateTypescriptDocs(options) {
     const plugin = [
         isMarkdown && 'typedoc-plugin-markdown',
         format === 'wiki' && 'typedoc-github-wiki-theme',
-        format === 'html' && 'typedoc-unhoax-theme',
+        format === 'html' && 'typedoc-github-theme',
     ].filter(Boolean);
     const app = await td.Application.bootstrapWithPlugins({
         entryPoints: [entryPoint ?? './src/index.ts'],
@@ -32,6 +32,9 @@ export async function generateTypescriptDocs(options) {
         app.options.setValue('propertyMembersFormat', 'table');
         app.options.setValue('typeDeclarationFormat', 'table');
     }
+    if (format === 'html') {
+        app.options.setValue('githubPages', true);
+    }
     const project = await app.convert();
     if (!project)
         panic('Failed to convert project');

package/dist/index.js

@@ -9,7 +9,7 @@ import { generateCommandDocumentation } from './commands/doc-command.js';
 import { release } from './commands/release-npm.js';
 import { upgradeDependencies } from './commands/deps-upgrade.js';
 import { generateDependencyGraph } from './commands/deps-graph.js';
-import { checkPackage } from './commands/check-package.js';
+import { check } from './commands/check.js';
 import { generateTypescriptDocs } from './commands/doc-typescript.js';
 /**
  * Main CLI program, configured with custom text styling for titles, commands, options, etc.
@@ -31,10 +31,10 @@ program
  * Command: check-package
  * Checks that the project's package.json includes certain required scripts/fields.
  */
-program.command('check-package')
-    .description('Check package.json for required scripts and other metadata.')
+program.command('check')
+    .description('Check repo for required scripts and other stuff.')
     .action(() => {
-    void checkPackage(process.cwd());
+    void check(process.cwd());
 });
 /**
  * Command: deps-graph

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -35,15 +35,15 @@
   "devDependencies": {
     "@schemastore/package": "^0.0.10",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.5",
-    "@typescript-eslint/eslint-plugin": "^8.22.0",
-    "@typescript-eslint/parser": "^8.22.0",
+    "@types/node": "^22.13.8",
+    "@typescript-eslint/eslint-plugin": "^8.25.0",
+    "@typescript-eslint/parser": "^8.25.0",
     "eslint": "^9.21.0",
     "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.2.6",
     "tsx": "^4.19.3",
     "typescript": "^5.7.3",
-    "typescript-eslint": "^8.24.1"
+    "typescript-eslint": "^8.25.0"
   },
   "dependencies": {
     "@inquirer/select": "^4.0.9",
@@ -51,9 +51,9 @@
     "dependency-cruiser": "^16.10.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "typedoc": "^0.27.8",
+    "typedoc": "^0.27.9",
+    "typedoc-github-theme": "^0.2.1",
     "typedoc-github-wiki-theme": "^2.1.0",
-    "typedoc-plugin-markdown": "^4.4.2",
-    "typedoc-unhoax-theme": "^0.4.6"
+    "typedoc-plugin-markdown": "^4.4.2"
   }
 }

package/dist/commands/check-package.d.ts

@@ -1 +0,0 @@
-export declare function checkPackage(directory: string): void;