@annoto/widget-api 3.60.0-alpha.1 → 3.64.0-alpha.0

package/scripts/docs.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+
+/**
+ * Execute multiple commands in sequence
+ * @param {string[]} commands - Array of commands to execute
+ * @param {string} description - Description of the overall operation
+ */
+function executeCommands(commands, description) {
+    console.log(`\n📚 ${description}`);
+
+    for (const command of commands) {
+        console.log(`Executing: ${command}`);
+        try {
+            execSync(command, {
+                stdio: 'inherit',
+                cwd: process.cwd(),
+            });
+        } catch (error) {
+            console.error(`❌ ${description} failed at command: ${command}`);
+            process.exit(1);
+        }
+    }
+    console.log(`✅ ${description} completed successfully\n`);
+}
+
+/**
+ * Documentation commands
+ */
+const docCommands = {
+    html() {
+        executeCommands(
+            ['npx rimraf docs', 'typedoc lib/ --theme default --watch'],
+            'Generate HTML documentation for preview using typedoc and open the result in a browser.'
+        );
+    },
+
+    publish() {
+        executeCommands(
+            ['npx rimraf docs', 'typedoc lib/ --theme default', 'node scripts/ghpages.js'],
+            'Generating HTML documentation using typedoc and publishing to GitHub pages'
+        );
+    },
+
+    json() {
+        executeCommands(
+            ['npm run build', 'rimraf docs', 'typedoc lib/ --json docs/typedoc.json'],
+            'Generating JSON documentation using typedoc'
+        );
+    },
+};
+
+// Yargs configuration
+const argv = yargs(hideBin(process.argv))
+    .usage('Usage: $0 <command>')
+    .command('html', 'Generate HTML documentation for preview using typedoc', {}, () =>
+        docCommands.html()
+    )
+    .command('publish', 'Generate HTML documentation and publish to GitHub pages', {}, () =>
+        docCommands.publish()
+    )
+    .command('json', 'Generate JSON documentation using typedoc', {}, () => docCommands.json())
+    .demandCommand(1, 'You need to specify a command')
+    .help('h')
+    .alias('h', 'help')
+    .example('$0 html', 'Generate HTML documentation')
+    .example('$0 publish', 'Publish documentation to GitHub pages')
+    .example('$0 json', 'Generate JSON documentation').argv;

package/scripts/ghpages.js

@@ -0,0 +1,14 @@
+const ghpages = require('gh-pages');
+
+
+const repo = 'https://github.com/Annoto/widget-api.git';
+
+ghpages.publish('docs', {
+    repo,
+}, (err) => {
+    if (err) {
+        return console.error(err);
+    }
+
+    console.log('gh-pages: published to ', repo);
+});

package/.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-    extends: '../../.eslintrc.js',
-    env: {
-        browser: true,
-    },
-    parserOptions: {
-        project: 'tsconfig.json',
-        sourceType: 'module',
-    },
-};