@ama-openapi/create 13.5.0-rc.1 → 13.6.0-prerelease.10

package/README.md

@@ -12,7 +12,7 @@ It helps developers quickly set up new OpenAPI projects with best practices and
 ## Usage
 
 ```shell
-npm create @ama-openapi <command> -- [options]
+npm create @ama-openapi -- [options]
 ```
 
 The following global options can be used with any command:
@@ -22,14 +22,12 @@ The following global options can be used with any command:
 | `--version`, `-v` | Display the current version of the generator. |
 | `--help`, `-h` | Display usage for the CLI commands. |
 
-## Available commands
+## Generate Open Api basic project
 
-### Design Project
-
-Create a new [OpenAPI](https://www.openapis.org/) design project via the following command :
+Create a new [OpenAPI](https://www.openapis.org/) basic project via the following command :
 
 ```shell
-npm create @ama-openapi design <project-name> -- [options]
+npm create @ama-openapi <project-name> -- [options]
 ```
 
 The following options are available:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-openapi/create",
-  "version": "13.5.0-rc.1",
+  "version": "13.6.0-prerelease.10",
   "publishConfig": {
     "access": "public"
   },
@@ -8,6 +8,15 @@
   "keywords": [
     "create"
   ],
+  "main": "./src/index.js",
+  "exports": {
+    ".": {
+      "default": "./src/index.js"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    }
+  },
   "bin": "./src/index.js",
   "scripts": {
     "nx": "nx",
@@ -18,7 +27,7 @@
     "postbuild": "cpy 'package.json' 'dist' && patch-package-json-main"
   },
   "peerDependencies": {
-    "@o3r/telemetry": "~13.5.0-rc.1",
+    "@o3r/telemetry": "~13.6.0-prerelease.10",
     "type-fest": "^4.30.1"
   },
   "peerDependenciesMeta": {
@@ -30,7 +39,7 @@
     }
   },
   "dependencies": {
-    "@ama-openapi/core": "~13.5.0-rc.1",
+    "@ama-openapi/core": "~13.6.0-prerelease.10",
     "ejs": "~3.1.9",
     "globby": "^11.1.0",
     "tslib": "^2.6.2",
@@ -43,11 +52,11 @@
     "@nx/eslint-plugin": "~21.6.0",
     "@nx/jest": "~21.6.0",
     "@nx/js": "~21.6.0",
-    "@o3r/build-helpers": "~13.5.0-rc.1",
-    "@o3r/eslint-config": "~13.5.0-rc.1",
-    "@o3r/eslint-plugin": "~13.5.0-rc.1",
-    "@o3r/telemetry": "~13.5.0-rc.1",
-    "@o3r/test-helpers": "~13.5.0-rc.1",
+    "@o3r/build-helpers": "~13.6.0-prerelease.10",
+    "@o3r/eslint-config": "~13.6.0-prerelease.10",
+    "@o3r/eslint-plugin": "~13.6.0-prerelease.10",
+    "@o3r/telemetry": "~13.6.0-prerelease.10",
+    "@o3r/test-helpers": "~13.6.0-prerelease.10",
     "@schematics/angular": "~20.3.13",
     "@stylistic/eslint-plugin": "~5.6.0",
     "@types/ejs": "^3.1.2",
@@ -56,7 +65,7 @@
     "@types/node": "~24.10.0",
     "@types/semver": "^7.3.13",
     "@types/yargs": "~17.0.33",
-    "@typescript-eslint/parser": "~8.49.0",
+    "@typescript-eslint/parser": "~8.51.0",
     "angular-eslint": "~20.6.0",
     "cpy-cli": "^6.0.0",
     "eslint": "~9.39.0",
@@ -64,7 +73,7 @@
     "eslint-import-resolver-typescript": "~4.4.0",
     "eslint-plugin-import": "~2.32.0",
     "eslint-plugin-import-newlines": "~1.4.0",
-    "eslint-plugin-jest": "~29.2.0",
+    "eslint-plugin-jest": "~29.11.0",
     "eslint-plugin-jsdoc": "~54.7.0",
     "eslint-plugin-prefer-arrow": "~1.2.3",
     "eslint-plugin-unicorn": "~60.0.0",
@@ -81,7 +90,7 @@
     "ts-jest": "~29.4.0",
     "type-fest": "^4.30.1",
     "typescript": "~5.9.2",
-    "typescript-eslint": "~8.49.0"
+    "typescript-eslint": "~8.51.0"
   },
   "generatorDependencies": {
     "@redocly/openapi-core": "~2.11.0"

package/templates/.gitignore.template

@@ -10,3 +10,6 @@ node_modules/
 
 # Bundle specifications directory
 /bundle
+
+# Local validation schemas
+/schemas

package/templates/openapi.manifest.yaml.template

@@ -1 +1 @@
-# yaml-language-server: $schema=https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/main/packages/@ama-openapi/core/schemas/manifest.schema.json
+# yaml-language-server: $schema=./schemas/manifest.schema.json

package/templates/package.json.template

@@ -1,10 +1,12 @@
 {
-  "$schema": "https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/main/packages/@ama-openapi/core/schemas/manifest.schema.json",
+  "$schema": "./schemas/manifest.schema.json",
   "name": "<%- packageName %>",
   "keywords": [
-    "open-api",
-    "ama-open-api",
-    "specification"
+<%-
+  packageKeywords
+    .map((keyword)=> `    "${keyword}"`)
+    .join(',\n')
+%>
   ],
   "preferUnplugged": true,
   "version": "0.0.0-placeholder",
@@ -22,6 +24,7 @@
     "build": "redocly bundle",
     "retrieve-externals": "ama-openapi install",
     "watch:retrieve-externals": "ama-openapi watch",
+    "prepare": "ama-openapi generate-schema"
     "postinstall": "ama-openapi install"
   },
   "dependencies": {

package/templates/schemas/manifest.schema.json.template

@@ -0,0 +1,3 @@
+{
+  "$ref": "https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/main/packages/@ama-openapi/core/schemas/manifest.schema.json"
+}

package/src/generate-template.d.ts

@@ -1,20 +0,0 @@
-/**
- * Options for template generation
- */
-export interface CreateOptions {
-    /** Target directory */
-    target: string;
-    /** Path to external models */
-    externalModelPath: string;
-    /** Version of the generator */
-    version: string;
-    /** Name of the package/artifact */
-    packageName: string;
-    /** Logger */
-    logger: typeof console;
-}
-/**
- * Generate Template files
- * @param options
- */
-export declare const generateTemplate: (options: CreateOptions) => Promise<void[]>;

package/src/generate-template.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTemplate = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const core_1 = require("@ama-openapi/core");
-const ejs_1 = require("ejs");
-const globby_1 = require("globby");
-const TEMPLATE_EXTENSION = '.template';
-const GIT_IGNORE_IO_URL = 'https://www.toptal.com/developers/gitignore/api/node';
-/**
- * Retrieve the gitignore content generated by gitignore.io
- * @param options
- */
-const getGitIgnoreContent = async (options) => {
-    let standardGitignoreNode = '';
-    try {
-        const gitignoreResponse = await fetch(GIT_IGNORE_IO_URL);
-        if (!gitignoreResponse.ok) {
-            throw new Error(`Non-OK response to ${GIT_IGNORE_IO_URL}`);
-        }
-        standardGitignoreNode = await gitignoreResponse.text();
-    }
-    catch (e) {
-        options.logger.warn('gitignore.io service are not available, a default minimal gitignore will be generated');
-        options.logger.debug(e);
-    }
-    return standardGitignoreNode;
-};
-/**
- * Generate Template files
- * @param options
- */
-const generateTemplate = async (options) => {
-    const { generatorDependencies, engines } = JSON.parse(await node_fs_1.promises.readFile((0, node_path_1.resolve)(__dirname, '..', 'package.json'), { encoding: 'utf8' }));
-    const templatesDirectory = (0, node_path_1.resolve)(__dirname, '..', 'templates');
-    const regExpExtension = new RegExp(`\\${TEMPLATE_EXTENSION}$`);
-    const exportedFiles = [
-        'bundle',
-        'models',
-        ...core_1.DEFAULT_MANIFEST_FILENAMES
-    ];
-    const generatedCode = (0, globby_1.sync)('**/*', { cwd: templatesDirectory, dot: true })
-        .map(async (templatePath) => {
-        const templatePathAbsolute = (0, node_path_1.resolve)(templatesDirectory, templatePath);
-        const content = await (0, ejs_1.renderFile)(templatePathAbsolute, {
-            ...options,
-            nodeSupportedRange: engines.node,
-            projectFolder: (0, node_path_1.basename)(options.target),
-            exportedFiles,
-            redoclyVersion: generatorDependencies['@redocly/openapi-core'],
-            standardGitignoreNode: await getGitIgnoreContent(options)
-        }, { async: true });
-        return {
-            templatePath,
-            content
-        };
-    })
-        .map(async (file) => {
-        const { templatePath, content } = await file;
-        const outputPath = (0, node_path_1.resolve)(options.target, templatePath.replace(regExpExtension, ''));
-        const outputDirectory = (0, node_path_1.dirname)(outputPath);
-        if (!(0, node_fs_1.existsSync)(outputDirectory)) {
-            await node_fs_1.promises.mkdir((0, node_path_1.dirname)(outputPath), { recursive: true });
-        }
-        await node_fs_1.promises.writeFile(outputPath, content, { encoding: 'utf8' });
-    });
-    return Promise.all(generatedCode);
-};
-exports.generateTemplate = generateTemplate;

package/src/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/src/index.js

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const core_1 = require("@ama-openapi/core");
-const yargs = require("yargs");
-const helpers_1 = require("yargs/helpers");
-const generate_template_1 = require("./generate-template");
-void (async () => {
-    const version = JSON.parse(await node_fs_1.promises.readFile((0, node_path_1.resolve)(__dirname, '..', 'package.json'), { encoding: 'utf8' })).version;
-    await yargs((0, helpers_1.hideBin)(process.argv))
-        .option('target', {
-        alias: 't',
-        type: 'string',
-        description: 'Target directory to generate the files into',
-        default: process.cwd()
-    })
-        .command('design <name>', 'Name of the artifact / package to generate', (y) => {
-        return y.positional('name', {
-            type: 'string',
-            demandOption: true,
-            describe: 'Name of the artifact / package to generate'
-        });
-    }, async (argv) => {
-        const options = {
-            target: argv.target,
-            externalModelPath: core_1.OUTPUT_DIRECTORY,
-            version,
-            packageName: argv.name,
-            logger: console
-        };
-        await (0, generate_template_1.generateTemplate)(options);
-    })
-        .version(version)
-        .alias('h', 'help')
-        .alias('v', 'version')
-        .parse();
-})();