@gasket/preset-api 7.0.3-cli.0 → 7.0.4

package/README.md

@@ -2,18 +2,10 @@
 
 Framework for building API's using Gasket.
 
-## Usage
-
-This preset requires v5 of the `@gasket/cli`:
-
-```bash
-npm i -g @gasket/cli@^5.0.0
-```
-
 ## Installation
 
 ```bash
-gasket create <app-name> --presets @gasket/preset-api
+npx create-gasket-app <app-name> --presets @gasket/preset-api
 ```
 
 ## Docs
@@ -22,7 +14,6 @@ To see complete the list of plugins configured in your app, and what commands, l
 
 ## Plugins
 
-- [@gasket/plugin-response-data](/packages/gasket-plugin-response-data/README.md)
 - [@gasket/plugin-swagger](/packages/gasket-plugin-swagger/README.md)
 - [@gasket/plugin-docs](/packages/gasket-plugin-docs/README.md)
 - [@gasket/plugin-docusaurus](/packages/gasket-plugin-docusaurus/README.md)

package/generator/README.md

@@ -0,0 +1,43 @@
+# {{{appName}}}
+
+{{{appDescription}}}
+
+## Overview
+
+This API is built with {{{server}}}.js framework and [Gasket](https://gasket.dev/). This application utilizes [EcmaScript Modules] and requires Node.js v20 or higher.
+
+## Getting Started
+
+### Development
+
+To start the API locally, run:
+
+```bash
+cd {{{appName}}}
+{{{installCmd}}}
+{{{localCmd}}}
+```
+
+### Debugging
+
+To start the API locally with debugging enabled, run:
+
+```bash
+DEBUG=* {{{localCmd}}}
+```
+
+Extended filtering of the debug output can be achieved by adding to the `DEBUG` environment variable:
+
+```bash
+DEBUG=gasket:* {{{localCmd}}} // gasket operations only
+DEBUG={{{server}}}:* {{{localCmd}}} // {{{server}}} operations only
+```
+
+{{#each readme.markdown}}
+{{{markdownCompile this}}}
+{{/each}}
+<!-- LINKS -->
+[EcmaScript Modules]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+{{#each readme.links}}
+{{{this}}}
+{{/each}}

package/generator/server.js

@@ -0,0 +1,6 @@
+import gasket from './gasket.js';
+{{#if apiApp }}
+import './routes/index.js';
+{{/if}}
+
+gasket.actions.startServer();

package/lib/create.js

@@ -0,0 +1,27 @@
+import path from 'path';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+const require = createRequire(import.meta.url);
+const { devDependencies } = require('../package.json');
+
+/** @type {import('@gasket/core').HookHandler<'create'>} */
+export default function create(gasket, context) {
+  const { pkg, files } = context;
+  const __dirname = fileURLToPath(import.meta.url);
+  const generatorDir = path.join(__dirname, '..', '..', 'generator');
+  files.add(`${generatorDir}/*.md`);
+
+  if (!context.typescript) {
+    files.add(`${generatorDir}/*.js`);
+
+    pkg.add('devDependencies', {
+      nodemon: devDependencies.nodemon
+    });
+
+    pkg.add('scripts', {
+      start: 'node server.js',
+      local: 'nodemon server.js',
+      preview: 'npm run start'
+    });
+  }
+}

package/lib/index.d.ts

@@ -1,9 +1,5 @@
-import '@gasket/plugin-response-data';
-import '@gasket/plugin-docs';
-import '@gasket/plugin-docusaurus';
 import '@gasket/plugin-express';
+import '@gasket/plugin-fastify';
 import '@gasket/plugin-https';
 import '@gasket/plugin-lint';
-import '@gasket/plugin-start';
-import '@gasket/plugin-swagger';
-import '@gasket/plugin-winston';
+import '@gasket/plugin-winston';

package/lib/index.js

@@ -1,6 +1,18 @@
-module.exports = {
-  require,
-  createContext: {
-    apiApp: true
+import { createRequire } from 'module';
+import presetPrompt from './preset-prompt.js';
+import presetConfig from './preset-config.js';
+import create from './create.js';
+const require = createRequire(import.meta.url);
+const { name, version, description } = require('../package.json');
+
+/** @type {import('@gasket/core').Preset} */
+export default {
+  name,
+  version,
+  description,
+  hooks: {
+    presetPrompt,
+    presetConfig,
+    create
   }
 };

package/lib/preset-config.js

@@ -0,0 +1,44 @@
+import pluginHttps from '@gasket/plugin-https';
+import pluginWinston from '@gasket/plugin-winston';
+import pluginLint from '@gasket/plugin-lint';
+
+/**
+ * presetConfig hook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ * @returns {Promise<CreateContext.presetConfig>} config
+ */
+export default async function presetConfig(gasket, context) {
+  const plugins = [
+    pluginHttps,
+    pluginWinston,
+    pluginLint
+  ];
+
+  const frameworkPlugin = context.server === 'express'
+    ? await import('@gasket/plugin-express')
+    : await import('@gasket/plugin-fastify');
+
+  plugins.push(frameworkPlugin.default || frameworkPlugin);
+
+  if ('testPlugins' in context && context.testPlugins.length > 0) {
+    await Promise.all(context.testPlugins.map(async (testPlugin) => {
+      const plugin = await import(testPlugin);
+      plugins.push(plugin ? plugin.default || plugin : null);
+    }));
+  }
+
+  if (context.typescript) {
+    const typescriptPlugin = await import('@gasket/plugin-typescript');
+    plugins.push(typescriptPlugin.default || typescriptPlugin);
+  }
+
+  if (context.useSwagger) {
+    const swaggerPlugin = await import('@gasket/plugin-swagger');
+    plugins.push(swaggerPlugin.default || swaggerPlugin);
+  }
+
+  return {
+    plugins: plugins.filter(Boolean)
+  };
+}

package/lib/preset-prompt.js

@@ -0,0 +1,34 @@
+import typescriptPrompts from '@gasket/plugin-typescript/prompts';
+import swaggerPrompts from '@gasket/plugin-swagger/prompts';
+
+/**
+ * presetPrompt hook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ * @param {Object} utils - Prompt utils
+ * @param {Function} utils.prompt - Inquirer prompt
+ */
+export default async function presetPrompt(gasket, context, { prompt }) {
+  context.apiApp = true;
+
+  await typescriptPrompts.promptTypescript(context, prompt);
+  await swaggerPrompts.promptSwagger(context, prompt);
+
+  if (!('server' in context)) {
+    const { server } = await prompt([
+      {
+        name: 'server',
+        message: 'Which server framework would you like to use?',
+        type: 'list',
+        choices: [
+          { name: 'Express', value: 'express' },
+          { name: 'Fastify', value: 'fastify' }
+        ]
+      }
+    ]);
+
+    Object.assign(context, { server });
+
+    return context;
+  }
+}

package/package.json

@@ -1,12 +1,22 @@
 {
   "name": "@gasket/preset-api",
-  "version": "7.0.3-cli.0",
+  "version": "7.0.4",
   "description": "Create Express-based API with Gasket",
-  "main": "lib",
+  "type": "module",
+  "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
+    "generator",
     "lib"
   ],
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
+    "test:watch": "npm run test -- --watch",
+    "test:coverage": "jest --coverage",
+    "posttest": "npm run lint"
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/godaddy/gasket.git"
@@ -19,18 +29,46 @@
   "bugs": {
     "url": "https://github.com/godaddy/gasket/issues"
   },
+  "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-preset-api",
   "dependencies": {
-    "@gasket/plugin-docs": "^7.0.3-cli.0",
-    "@gasket/plugin-docusaurus": "^7.0.0-cli.0",
-    "@gasket/plugin-express": "^7.0.0-cli.0",
-    "@gasket/plugin-https": "^7.0.0-cli.0",
-    "@gasket/plugin-lint": "^7.0.0-cli.0",
-    "@gasket/plugin-response-data": "^7.0.0-cli.0",
-    "@gasket/plugin-swagger": "^7.0.0-cli.0",
-    "@gasket/plugin-winston": "^7.0.3-cli.0"
+    "@gasket/plugin-cypress": "^7.0.3",
+    "@gasket/plugin-express": "^7.0.4",
+    "@gasket/plugin-fastify": "^7.0.4",
+    "@gasket/plugin-https": "^7.0.4",
+    "@gasket/plugin-jest": "^7.0.1",
+    "@gasket/plugin-lint": "^7.0.3",
+    "@gasket/plugin-mocha": "^7.0.4",
+    "@gasket/plugin-swagger": "^7.0.1",
+    "@gasket/plugin-typescript": "^7.0.1",
+    "@gasket/plugin-winston": "^7.0.4"
   },
   "devDependencies": {
-    "@gasket/plugin-start": "^7.0.0-cli.0"
+    "cross-env": "^7.0.3",
+    "eslint": "^8.56.0",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-unicorn": "^55.0.0",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.0"
+  },
+  "eslintConfig": {
+    "extends": [
+      "godaddy",
+      "plugin:jest/recommended"
+    ],
+    "plugins": [
+      "unicorn"
+    ],
+    "rules": {
+      "unicorn/filename-case": "error"
+    }
+  },
+  "eslintIgnore": [
+    "test/fixtures",
+    "generator"
+  ],
+  "jest": {
+    "transform": {}
   },
-  "gitHead": "ffcc0372192c096dba45d684d9fe3926edd6cc71"
+  "gitHead": "af49c0e42e7947e000faa771777b815b90aaffa3"
 }