@nebula.js/cli-create 7.2.0 → 7.4.0

package/README.md

@@ -28,6 +28,8 @@ Options:
   --install   Run package installation step            [boolean] [default: true]
   --pkgm      Package manager          [string] [choices: "npm", "yarn", "pnpm"]
   --picasso   Picasso template [string] [choices: "none", "minimal", "barchart"]
+  --typescript Generate a TypeScript visualization scaffold
+                                                      [boolean] [default: false]
   --author    Package author                                            [string]
   -h, --help  Show help                                                [boolean]
 ```
@@ -65,6 +67,10 @@ options.
 - minimal: a basic setup of picasso.js is ready
 - barchart: a bar chart component created by picasso.js is ready
 
+Generate a TypeScript visualization scaffold by adding `--typescript`. This
+adds `tsconfig.json`, `nebula.config.js`, TypeScript build dependencies, and
+TypeScript source files for the generated visualization.
+
 You can find the [tutorial](https://qlik.dev/extend/extend-quickstarts/first-extension) to build a basic nebula visualization using nebula.js.
 
 #### Create a mashup
@@ -103,3 +109,11 @@ Create a mashup and do not install any dependencies yet
 ```sh
 nebula create mashup table-mashup --install false
 ```
+
+#### TypeScript scaffold
+
+Create a nebula visualization project with a TypeScript scaffold
+
+```sh
+nebula create sn-table --typescript
+```

package/command.js

@@ -44,6 +44,11 @@ export default {
       type: 'string',
       description: 'Package author',
     });
+    yargs.option('typescript', {
+      type: 'boolean',
+      default: false,
+      description: 'Generate a TypeScript visualization scaffold',
+    });
   },
   handler(argv) {
     create(argv);

package/lib/create.js

@@ -59,11 +59,49 @@ function copyFactory(root, destination) {
   };
 }
 
+const renameJavascriptSourcesToTypescript = (target) => {
+  if (!fse.existsSync(target)) {
+    return;
+  }
+
+  const entries = fs.readdirSync(target, { withFileTypes: true });
+  entries.forEach((entry) => {
+    const currentPath = path.resolve(target, entry.name);
+    if (entry.isDirectory()) {
+      renameJavascriptSourcesToTypescript(currentPath);
+      return;
+    }
+
+    if (entry.isFile() && path.extname(entry.name) === '.js') {
+      const nextPath = currentPath.replace(/\.js$/, '.ts');
+      fs.renameSync(currentPath, nextPath);
+    }
+  });
+};
+
+const scaffoldTypescript = ({ destination }) => {
+  renameJavascriptSourcesToTypescript(path.resolve(destination, 'src'));
+
+  fs.copyFileSync(
+    path.resolve(moduleDir, '../templates/sn/typescript/tsconfig.json'),
+    path.resolve(destination, 'tsconfig.json')
+  );
+  fs.copyFileSync(
+    path.resolve(moduleDir, '../templates/sn/typescript/nebula.config.js'),
+    path.resolve(destination, 'nebula.config.js')
+  );
+};
+
 const create = async (argv) => {
   const { name } = argv;
 
   const isMashup = argv._.includes('mashup');
 
+  if (isMashup && argv.typescript) {
+    console.error(chalk.red('TypeScript scaffolding is only supported for visualizations.'));
+    process.exit(1);
+  }
+
   const projectFolder = name;
   const packageName = name.split('/').slice(-1)[0];
 
@@ -129,6 +167,7 @@ const create = async (argv) => {
       user: options.author.name,
       email: options.author.email,
       nebulaVersion: pkg.version,
+      typescript: Boolean(options.typescript),
     };
 
     const traverse = (sourceFolder, targetFolder = '') => {
@@ -153,6 +192,10 @@ const create = async (argv) => {
     folders.forEach((folder) => {
       traverse(folder);
     });
+
+    if (options.typescript) {
+      scaffoldTypescript({ destination });
+    }
   };
 
   const install = async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/cli-create",
-  "version": "7.2.0",
+  "version": "7.4.0",
   "description": "",
   "type": "module",
   "license": "MIT",
@@ -24,9 +24,11 @@
   },
   "dependencies": {
     "@inquirer/prompts": "8.5.2",
-    "chalk": "4.1.2",
+    "chalk": "6.0.0",
     "ejs": "6.0.1",
-    "fs-extra": "11.4.0"
+    "fs-extra": "11.4.0",
+    "picasso-plugin-q": "2.11.5",
+    "picasso.js": "2.11.5"
   },
-  "gitHead": "44ddc01b77f775b3a2b028f991a6dfd349a70871"
+  "gitHead": "c080c816b30c0caf2647330f8f7320fc81ee1002"
 }

package/templates/mashup/_package.json

@@ -16,7 +16,7 @@
     "@nebula.js/stardust": "<%= nebulaVersion %>",
     "@nebula.js/sn-bar-chart": "^2.2.0",
     "@qlik/api": "2.7.0",
-    "enigma.js": "^2.14.0",
+    "enigma.js": "2.14.0",
     "parcel": "2.16.4"
   }
 }

package/templates/sn/common/playwright.config.js

@@ -17,7 +17,7 @@ export default {
   ],
 
   webServer: {
-    command: 'yarn start --port 8077 --open false',
+    command: 'pnpm start --port 8077 --open false',
     reuseExistingServer: !process.env.CI,
     port: '8077',
   },

package/templates/sn/none/_package.json

@@ -15,7 +15,7 @@
   "main": "dist/<%= name %>.js",
   "module": "dist/<%= name %>.esm.js",
   "scripts": {
-    "build": "nebula build",
+    "build": "nebula build<% if (typescript) { %> --typescript<% } %>",
     "start": "nebula serve",
     "sense": "nebula sense --meta src/meta.json",
     "test:e2e": "playwright test",
@@ -26,7 +26,10 @@
     "@nebula.js/cli-build": "<%= nebulaVersion %>",
     "@nebula.js/cli-serve": "<%= nebulaVersion %>",
     "@nebula.js/cli-sense": "<%= nebulaVersion %>",
-    "@playwright/test": "^1.59.1"
+    "@playwright/test": "^1.59.1"<% if (typescript) { %>,
+    "@rollup/plugin-typescript": "12.3.0",
+    "tslib": "^2.8.1",
+    "typescript": ">=5.9.3 <7"<% } %>
   },
   "peerDependencies": {
     "@nebula.js/stardust": ">=7.0.0"

package/templates/sn/picasso/common/_package.json

@@ -15,7 +15,7 @@
   "main": "dist/<%= name %>.js",
   "module": "dist/<%= name %>.esm.js",
   "scripts": {
-    "build": "nebula build",
+    "build": "nebula build<% if (typescript) { %> --typescript<% } %>",
     "start": "nebula serve",
     "sense": "nebula sense",
     "test:e2e": "playwright test",
@@ -28,7 +28,10 @@
     "@nebula.js/cli-sense": "<%= nebulaVersion %>",
     "@playwright/test": "^1.28.1",
     "picasso.js": "2.1.1",
-    "picasso-plugin-q": "2.1.1"
+    "picasso-plugin-q": "2.1.1"<% if (typescript) { %>,
+    "@rollup/plugin-typescript": "12.3.0",
+    "tslib": "^2.8.1",
+    "typescript": ">=5.9.3 <7"<% } %>
   },
   "peerDependencies": {
     "@nebula.js/stardust": ">=7.0.0"

package/templates/sn/typescript/nebula.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  build: {
+    typescript: true,
+  },
+};

package/templates/sn/typescript/src/index.ts

@@ -0,0 +1 @@
+export {};

package/templates/sn/typescript/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": false
+  },
+  "include": ["src/**/*.ts"]
+}