@gasket/preset-api 7.0.0-next.6 → 7.0.0-next.60

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/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

@@ -1,23 +1,30 @@
+import path from 'path';
 import { createRequire } from 'module';
 import { fileURLToPath } from 'url';
 const require = createRequire(import.meta.url);
-const { dependencies, devDependencies } = require('../package.json');
+const { devDependencies } = require('../package.json');
 
+/**
+ * createHook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ */
 export default function create(gasket, context) {
   const { pkg, files } = context;
   const __dirname = fileURLToPath(import.meta.url);
-  const generatorDir = `${__dirname}/../../generator`;
-
-  pkg.add('dependencies', dependencies);
+  const generatorDir = path.join(__dirname, '..', '..', 'generator');
 
   if (!context.typescript) {
     files.add(`${generatorDir}/*`);
 
-    pkg.add('devDependencies', devDependencies);
+    pkg.add('devDependencies', {
+      nodemon: devDependencies.nodemon
+    });
 
     pkg.add('scripts', {
       start: 'node server.js',
-      local: 'GASKET_ENV=local nodemon server.js'
+      local: 'GASKET_ENV=local nodemon server.js',
+      preview: 'npm run build && 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

@@ -3,10 +3,13 @@ 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 } = require('../package.json');
+const { name, version, description } = require('../package.json');
 
+// TODO: need to create types for "preset" plugins
 export default {
   name,
+  version,
+  description,
   hooks: {
     presetPrompt,
     presetConfig,

package/lib/preset-config.js

@@ -1,34 +1,44 @@
-import pluginExpress from '@gasket/plugin-express';
 import pluginHttps from '@gasket/plugin-https';
-import pluginDocs from '@gasket/plugin-docs';
-import pluginDocusaurus from '@gasket/plugin-docusaurus';
-import pluginResponseData from '@gasket/plugin-response-data';
 import pluginWinston from '@gasket/plugin-winston';
-import pluginSwagger from '@gasket/plugin-swagger';
 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) {
-  let testPlugin, typescriptPlugin;
-  if ('testPlugin' in context) {
-    testPlugin = await import(context.testPlugin);
+  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) {
-    typescriptPlugin = await import('@gasket/plugin-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: [
-      pluginExpress,
-      pluginHttps,
-      pluginDocs,
-      pluginDocusaurus,
-      pluginResponseData,
-      pluginWinston,
-      pluginSwagger,
-      pluginLint,
-      typescriptPlugin ? typescriptPlugin.default || typescriptPlugin : null,
-      testPlugin ? testPlugin.default || testPlugin : null
-    ].filter(Boolean)
+    plugins: plugins.filter(Boolean)
   };
 }

package/lib/preset-prompt.js

@@ -1,16 +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;
 
-  if (!('typescript' in context)) {
-    const { typescript } = await prompt([
+  await typescriptPrompts.promptTypescript(context, prompt);
+  await swaggerPrompts.promptSwagger(context, prompt);
+
+  if (!('server' in context)) {
+    const { server } = await prompt([
       {
-        name: 'typescript',
-        message: 'Do you want to use TypeScript?',
-        type: 'confirm',
-        default: false
+        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, { typescript });
+    Object.assign(context, { server });
+
+    return context;
   }
 }

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@gasket/preset-api",
-  "version": "7.0.0-next.6",
+  "version": "7.0.0-next.60",
   "description": "Create Express-based API with Gasket",
+  "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
+    "generator",
     "lib"
   ],
-  "type": "module",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
-    "test:watch": "jest --watch",
+    "test:watch": "npm run test -- --watch",
     "test:coverage": "jest --coverage",
     "posttest": "npm run lint"
   },
@@ -29,24 +30,23 @@
     "url": "https://github.com/godaddy/gasket/issues"
   },
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.6",
-    "@gasket/engine": "^7.0.0-next.6",
-    "@gasket/plugin-docs": "^7.0.0-next.6",
-    "@gasket/plugin-docusaurus": "^7.0.0-next.6",
-    "@gasket/plugin-express": "^7.0.0-next.6",
-    "@gasket/plugin-https": "^7.0.0-next.6",
-    "@gasket/plugin-lint": "^7.0.0-next.6",
-    "@gasket/plugin-response-data": "^7.0.0-next.6",
-    "@gasket/plugin-swagger": "^7.0.0-next.6",
-    "@gasket/plugin-winston": "^7.0.0-next.6",
-    "@gasket/utils": "^7.0.0-next.6"
+    "@gasket/plugin-cypress": "7.0.0-next.60",
+    "@gasket/plugin-express": "7.0.0-next.60",
+    "@gasket/plugin-fastify": "7.0.0-next.60",
+    "@gasket/plugin-https": "7.0.0-next.60",
+    "@gasket/plugin-jest": "7.0.0-next.60",
+    "@gasket/plugin-lint": "7.0.0-next.60",
+    "@gasket/plugin-mocha": "7.0.0-next.60",
+    "@gasket/plugin-swagger": "7.0.0-next.60",
+    "@gasket/plugin-typescript": "7.0.0-next.60",
+    "@gasket/plugin-winston": "7.0.0-next.60"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
-    "eslint-plugin-jest": "^27.6.3",
-    "eslint-plugin-unicorn": "^44.0.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"
   },
@@ -63,10 +63,11 @@
     }
   },
   "eslintIgnore": [
-    "test/fixtures"
+    "test/fixtures",
+    "generator"
   ],
   "jest": {
     "transform": {}
   },
-  "gitHead": "805a1026959d8aa783ee32be8a8ff76c06badd2f"
+  "gitHead": "ea9feae6cd291d4361c06e09659e50dbec19bcea"
 }