@staffbase/create-staffbase-plugin 1.0.6 → 1.0.14

package/.github/CODEOWNERS

@@ -1,9 +1 @@
-# Shared
-.github/CODEOWNERS      @Staffbase/cc-tech
-
-# Global
-*                       @maximizeIT
-
-# Misc
-package.json            @maximizeIT @Staffbot
-yarn.lock               @maximizeIT @Staffbot
+*   @Staffbase/cs-tech

package/.github/dependabot.yml

@@ -1,9 +1,4 @@
 version: 2
-registries:
-  npm-github:
-    type: npm-registry
-    url: https://npm.pkg.github.com
-    token: ${{secrets.STAFFBOT_NPM_READ}}
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
@@ -11,7 +6,7 @@ updates:
       interval: "daily"
       time: "08:00"
       timezone: "Europe/Berlin"
-    target-branch: "master"
+    target-branch: "main"
     open-pull-requests-limit: 10
     labels:
       - "github dependency"
@@ -33,14 +28,12 @@ updates:
       interval: "daily"
       time: "08:00"
       timezone: "Europe/Berlin"
-    target-branch: "master"
+    target-branch: "main"
     open-pull-requests-limit: 10
     labels:
       - "npm dependency"
     reviewers:
       - "maximizeIT"
-    registries:
-      - npm-github
     commit-message:
       prefix: chore(deps)
     groups:

package/.github/workflows/auto-merge.yml

@@ -4,7 +4,7 @@ on: pull_request
 
 jobs:
   dependabot:
-    uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v4.0.2
+    uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v9.1.0
     secrets:
       app_id: ${{ vars.STAFFBASE_ACTIONS_APP_ID }}
       private_key: ${{ secrets.STAFFBASE_ACTIONS_PRIVATE_KEY }}

package/.github/workflows/publish-npm.yml

@@ -0,0 +1,22 @@
+name: Publish to NPM Registry
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Publish package on NPM 📦
+        run: npm publish --provenance --access public

package/{README.MD → README.md}

@@ -1,5 +1,6 @@
 # Create-Staffbase-SSO-CLI Documentation
-![Staffbase Logo](https://staffbase.com/wp-content/themes/staffbase-theme/img/logo-blau.svg)
+<img src="docs/assets/images/staffbase.png" alt="Staffbase SE" width="96" />
+
 ## Getting started
 Install the package in your global namespace and then run the command.
 
@@ -15,6 +16,7 @@ Example:
 ```bash
 $ yarn create @staffbase/staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server
 ```
+
 ## Interactive Mode
 You can also run the command without passing any arguments to get into interactive
 mode which would ask you the name of your app and the path where it need to be installed.
@@ -74,19 +76,19 @@ $ npm start
 
 ## License
 
-Copyright 2017-2024 Staffbase GmbH.
+Copyright 2017-2025 Staffbase SE.
 
 Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
 
 <table>
   <tr>
     <td>
-      <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
+      <img src="docs/assets/images/staffbase.png" alt="Staffbase SE" width="96" />
     </td>
     <td>
-      <b>Staffbase GmbH</b>
-      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
-      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
+      <b>Staffbase SE</b>
+      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">https://staffbase.com/jobs</a>
+      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">Jobs</a>
     </td>
   </tr>
 </table>

package/catalog-info.yaml

@@ -0,0 +1,14 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: create-staffbase-plugin-nodejs
+  description: Node.js plugin skeleton generator provided by Staffbase
+  annotations:
+    github.com/project-slug: Staffbase/create-staffbase-plugin-nodejs
+    jfrog-artifactory/image-name: create-staffbase-plugin-nodejs
+  tags:
+    - js
+    - nodejs
+spec:
+  type: service
+  lifecycle: production

package/csss.js

@@ -1,39 +1,40 @@
 #! /usr/bin/env node
-'use strict';
-const fs = require('fs-extra');
-const path = require('path');
-const yargv = require('yargs');
-const validateNPM = require('validate-npm-package-name');
-const execFile = require('child_process').execFile;
-const prompt = require('prompt');
-const filepath = require('filepath');
-const validatePath = require('./lib/helpers').validatePath;
-const isRelativePath = require('is-relative');
-const colors = require('colors/safe');
+"use strict";
+const fs = require("fs-extra");
+const path = require("path");
+const yargs = require("yargs");
+const validateNPM = require("validate-npm-package-name");
+const execFile = require("child_process").execFile;
+const prompt = require("prompt");
+const filepath = require("filepath");
+const validatePath = require("./lib/helpers").validatePath;
+const isRelativePath = require("is-relative");
+const colors = require("colors/safe");
 
 // configure prompt
-prompt.message = '';
-prompt.delimiter = colors.green(':');
+prompt.message = "";
+prompt.delimiter = colors.green(":");
 // set default values
-const defaultNPMName = 'my-staffbase-backend';
-const scaffoldFolder = path.resolve(__dirname, './scaffoldTpl');
+const defaultNPMName = "my-staffbase-backend";
+const scaffoldFolder = path.resolve(__dirname, "./scaffoldTpl");
 
-yargv
-    .usage('Usage: create-staffbase-sso-server <project-directory> [Options]')
-    .alias('name', 'N')
-    .string('name')
-    .describe('name', 'a sepcific package.json name of your app')
-    .version('0.0.1')
-    .help('help')
-    .epilogue(`for more information,\please see the README at:
-    https://github.com/Staffbase/create-staffbase-plugin-nodejs/blob/master/README.MD`);
-// console.log('YARGS Parsed Data:\n', yargv.argv);
-const packageJSON = fs.readJSONSync(path.join(scaffoldFolder, 'package.json'));
+const yargv = yargs(process.argv.slice(2))
+  .usage("Usage: create-staffbase-sso-server <project-directory> [Options]")
+  .alias("name", "N")
+  .string("name")
+  .describe("name", "a specific package.json name of your app")
+  .version("0.0.1")
+  .help("help")
+  .epilogue(`for more information,\please see the README at:
+    https://github.com/Staffbase/create-staffbase-plugin-nodejs/blob/main/README.MD`)
+  .argv;
+// console.log('YARGS Parsed Data:\n', yargv);
+const packageJSON = fs.readJSONSync(path.join(scaffoldFolder, "package.json"));
 // Defaults package name to current folder name
-const nameParam = yargv.argv.N || yargv.argv.name || defaultNPMName;
+const nameParam = yargv.N || yargv.name || defaultNPMName;
 prompt.override = {
-  name: yargv.argv.N,
-  path: yargv.argv._[0],
+  name: yargv.N,
+  path: yargv._[0],
 };
 /**
  * Prompts user for just the npm name value.
@@ -44,25 +45,24 @@ function promptName(name) {
   const namePromptSchema = {
     properties: {
       name: {
-        description: 'What is the npm name of your plugin?',
-        type: 'string',
+        description: "What is the npm name of your plugin?",
+        type: "string",
         default: name,
-        message: 'Name must be npm.js compatible',
+        message: "Name must be npm.js compatible",
         required: true,
-        conform: function(value) {
+        conform: function (value) {
           return validateNPM(value).validForNewPackages;
         },
       },
     },
   };
-  return new Promise(function(resolve, reject) {
-    prompt.start()
-        .get(namePromptSchema, function(err, res) {
-          if (err) {
-            return reject(err);
-          }
-          return resolve(res);
-        });
+  return new Promise(function (resolve, reject) {
+    prompt.start().get(namePromptSchema, function (err, res) {
+      if (err) {
+        return reject(err);
+      }
+      return resolve(res);
+    });
   });
 }
 /**
@@ -75,33 +75,34 @@ function promptPath(promtedName) {
   const pathPromptSchema = {
     properties: {
       path: {
-        description: 'Please enter the folder path for the App',
-        type: 'string',
+        description: "Please enter the folder path for the new plugin project",
+        type: "string",
         message:
-          'Entered path is invalid or an already present file on the File System. Please enter a correct filepath,',
+          "Entered path is invalid or an already present file on the File System. Please enter a correct filepath.",
         default: defPath,
         required: true,
         conform: validatePath,
       },
       override: {
         message:
-          colors.yellow('The directory you specified already exists. It directory will be overridden!') +
-            '\nDo you wish to proceed (y)es|(n)o?',
+          colors.yellow(
+            "The directory you specified already exists. The directory will be overridden!"
+          ) + "\nDo you wish to proceed (y)es|(n)o?",
         validator: /y[es]*|n[o]?/,
-        warning: 'Must respond yes or no',
-        default: 'yes',
-        ask: function() {
+        warning: "Must respond yes or no",
+        default: "yes",
+        ask: function () {
           let chkPath = defPath;
-          if (prompt.history('path')) {
-            chkPath = prompt.history('path').value;
+          if (prompt.history("path")) {
+            chkPath = prompt.history("path").value;
           }
           return filepath.create(chkPath).exists();
         },
       },
     },
   };
-  return new Promise(function(resolve, reject) {
-    prompt.get(pathPromptSchema, function(err, res) {
+  return new Promise(function (resolve, reject) {
+    prompt.get(pathPromptSchema, function (err, res) {
       if (err) {
         return reject(err);
       }
@@ -111,18 +112,18 @@ function promptPath(promtedName) {
 }
 
 /**
- * Copy contants from the Scaffold Template to the specified folder
- * @param  {String} dstDir THe destination directory where files are to be copied
+ * Copy contents from the Scaffold Template to the specified folder
+ * @param  {String} dstDir The destination directory where files are to be copied
  * @return {Promise}    Promise resolved when the copy process is complete. Rejected
  * if there is some error in copying files.
  */
 function copyContents(dstDir) {
   // console.log(colors.blue('Copying from:' + path.resolve(__dirname, './scaffoldTpl')));
-  const scaffoldFolder = path.resolve(__dirname, './scaffoldTpl');
+  const scaffoldFolder = path.resolve(__dirname, "./scaffoldTpl");
   return fs.copy(scaffoldFolder, dstDir);
 }
 /**
- * Repace the package.json file from copied fromplate to the new generated one.
+ * Replace the package.json file from copied template to the new generated one.
  * @return {Promise} Promise resolved when the Package.json is successfully replaced.
  * @param {String}  dstPath  The path of the folder where the package.json needs to be replaced
  * @param {String}  nameVal name value that should be replaced
@@ -130,14 +131,13 @@ function copyContents(dstDir) {
  */
 function replacePackageJSON(dstPath, nameVal) {
   // console.log("replacePackageJSON");
-  const newPackageJSON = Object.assign({}, packageJSON, {name: nameVal});
+  const newPackageJSON = Object.assign({}, packageJSON, { name: nameVal });
   const curDir = path.resolve(dstPath);
-  const packagePath = path.resolve(path.join(curDir, 'package.json'));
-  return fs.remove(packagePath)
-      .then(function(data) {
-        // console.log(colors.yellow('Writing json...'));
-        return fs.writeJson(packagePath, newPackageJSON, {spaces: 2});
-      });
+  const packagePath = path.resolve(path.join(curDir, "package.json"));
+  return fs.remove(packagePath).then(function (data) {
+    // console.log(colors.yellow('Writing json...'));
+    return fs.writeJson(packagePath, newPackageJSON, { spaces: 2 });
+  });
 }
 /**
  * Installs the node modules in the folder where the template was created.
@@ -146,12 +146,12 @@ function replacePackageJSON(dstPath, nameVal) {
  * @return {Promise}      Promise resolved when the packages are successfulyl installed.
  */
 function installDeps(dstPath) {
-  console.log(colors.italic('\nInstalling dependencies...'));
+  console.log(colors.italic("\nInstalling dependencies..."));
   const opts = {
     cwd: path.resolve(dstPath),
   };
-  return new Promise( (resolve, reject) => {
-    execFile('npm', ['install'], opts, (err, stdout, stderr) => {
+  return new Promise((resolve, reject) => {
+    execFile("npm", ["install"], opts, (err, stdout, stderr) => {
       // console.log(colors.red('Inside Child result', stderr, stdout, err));
       if (err) {
         // console.log(colors.red(err));
@@ -170,11 +170,10 @@ function installDeps(dstPath) {
 function removeExistingFolder(dstPath) {
   const fp = filepath.create(dstPath);
   if (fp.exists()) {
-    return fs.remove(fp.toString())
-        .then(function() {
-          console.log(colors.red('Removing existing folder and its contents...'));
-          return dstPath;
-        });
+    return fs.remove(fp.toString()).then(function () {
+      console.log(colors.red("Removing existing folder and its contents..."));
+      return dstPath;
+    });
   } else {
     return Promise.resolve(dstPath);
   }
@@ -183,56 +182,58 @@ function removeExistingFolder(dstPath) {
 const promptRes = {};
 // promot package name
 promptName(nameParam)
-// prompt file path
-    .then(function(pathResp) {
-      const nameRecv = pathResp.name;
-      Object.assign(promptRes, pathResp);
-      return promptPath(nameRecv);
-    })
-// remove the folder if it exists
-    .then(function(pathResp) {
-      if (pathResp.override === 'n' || pathResp.override === 'no') {
-        return Promise.reject(console.log(colors.green('Good Bye!')));
-      }
-      Object.assign(promptRes, pathResp);
-      let pathRecv = pathResp.path;
-      // if the entered path is relative, resolve to absolute
-      if (isRelativePath(pathRecv)) {
-        pathRecv = path.resolve(path.join(process.cwd(), pathRecv));
-        promptRes.path = pathRecv;
-      }
-      return removeExistingFolder(pathRecv);
-    })
-// copy contents to folder
-    .then((pathRecv) => {
-      return (copyContents(pathRecv));
-    })
-// replace package.json with new one
-    .then((res) => {
-      return replacePackageJSON(promptRes.path, promptRes.name);
-    })
-// install npm dependencies
-    .then((res) => {
-      return installDeps(promptRes.path);
-    })
-// output end results
-    .then(function(npmOutput) {
-      console.log(colors.yellow(npmOutput));
-      console.log(colors.green(`
+  // prompt file path
+  .then(function (pathResp) {
+    const nameRecv = pathResp.name;
+    Object.assign(promptRes, pathResp);
+    return promptPath(nameRecv);
+  })
+  // remove the folder if it exists
+  .then(function (pathResp) {
+    if (pathResp.override === "n" || pathResp.override === "no") {
+      return Promise.reject(console.log(colors.green("Good Bye!")));
+    }
+    Object.assign(promptRes, pathResp);
+    let pathRecv = pathResp.path;
+    // if the entered path is relative, resolve to absolute
+    if (isRelativePath(pathRecv)) {
+      pathRecv = path.resolve(path.join(process.cwd(), pathRecv));
+      promptRes.path = pathRecv;
+    }
+    return removeExistingFolder(pathRecv);
+  })
+  // copy contents to folder
+  .then((pathRecv) => {
+    return copyContents(pathRecv);
+  })
+  // replace package.json with new one
+  .then((res) => {
+    return replacePackageJSON(promptRes.path, promptRes.name);
+  })
+  // install npm dependencies
+  .then((res) => {
+    return installDeps(promptRes.path);
+  })
+  // output end results
+  .then(function (npmOutput) {
+    console.log(colors.yellow(npmOutput));
+    console.log(
+      colors.green(`
 Your application setup is complete!
 Please see the generated README.MD file to get more details about next steps.
 You can find your application template in: ${promptRes.path}.
-    `));
-    })
-// handle errors if any
-    .catch(function(err) {
-      if (err.message === 'canceled') {
-        return console.log(colors.green('\nGood Bye!'));
-      }
-      if (err.message) {
-        console.log('An error occured.', err);
-      }
-    });
+    `)
+    );
+  })
+  // handle errors if any
+  .catch(function (err) {
+    if (err.message === "canceled") {
+      return console.log(colors.green("\nGood Bye!"));
+    }
+    if (err.message) {
+      console.log("An error occurred.", err);
+    }
+  });
 
 module.exports = {
   validatePath: validatePath,

package/csss.test.js

@@ -1,13 +1,13 @@
-const validatePath = require('./lib/helpers').validatePath;
+const validatePath = require("./lib/helpers").validatePath;
 
-const validPath = './scaffoldTpl';
-const inValidPath = '*/,js';
+const validPath = "./scaffoldTpl";
+const inValidPath = "*/,js";
 
-describe('Testing csss.validatePath', () => {
-  test('test validating existing path', () => {
+describe("Testing csss.validatePath", () => {
+  test("test validating existing path", () => {
     expect(validatePath(validPath)).toBe(true);
   });
-  test('test validating invalid path', () => {
+  test("test validating invalid path", () => {
     expect(validatePath(inValidPath)).toBe(false);
   });
 });

package/lib/helpers.js

@@ -1,5 +1,5 @@
-const isValidPath = require('is-valid-path');
-const filepath = require('filepath');
+const isValidPath = require("is-valid-path");
+const filepath = require("filepath");
 /**
  * Checks if the path specified is valid for setting up the template.
  * Valid means if the path is a valid path and it is not a File (not a folder).
@@ -13,7 +13,7 @@ function validatePath(path) {
   try {
     const fp = filepath.create(path);
     // console.log(colors.yellow(fp));
-    return !(fp.isFile());
+    return !fp.isFile();
   } catch (err) {
     console.log(err);
   }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@staffbase/create-staffbase-plugin",
-  "version": "1.0.6",
+  "version": "1.0.14",
+  "license": "MIT",
   "bin": {
     "create-staffbase-plugin": "csss.js"
   },
@@ -25,27 +26,25 @@
     "is-relative": "^1.0.0",
     "is-valid-path": "^0.1.1",
     "prompt": "^1.0.0",
-    "validate-npm-package-name": "^3.0.0",
-    "yargs": "^15.3.1"
+    "validate-npm-package-name": "^7.0.1",
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/eslint-parser": "^7.0.0",
-    "@emotion/eslint-plugin": "^11.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
-    "eslint": "^8.33.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-react": "^7.32.2",
-    "eslint-plugin-import-helpers": "^1.1.0",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "@babel/core": "^7.28.5",
+    "@babel/eslint-parser": "^7.28.5",
+    "@typescript-eslint/eslint-plugin": "^8.51.0",
+    "@typescript-eslint/parser": "^8.51.0",
+    "eslint": "^9.39.2",
     "eslint-config-google": "^0.14.0",
-    "highlight.js": "^10.0.3",
-    "husky": "^4.2.5",
-    "jest": "^26.0.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "highlight.js": "^11.11.1",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
     "markdown-it": "^12.3.2",
     "marked": "^4.0.10",
-    "typescript": "^4.9.5"
+    "typescript": "^5.9.3"
   }
 }

package/scaffoldTpl/README.MD

@@ -1,5 +1,3 @@
-![Staffbase Logo](https://staffbase.com/wp-content/themes/staffbase-theme/img/logo-blau.svg)
-
 Welcome to your Staffbase SSO plugin server. Please follow the following instructions
 to get started with your Plugin Application.
 
@@ -49,4 +47,4 @@ $ npm start
 For getting more information about Staffbase SSO, please check out the following links:
 
 - [Developer Portal: Custom Plugins](https://developers.staffbase.com/concepts/customplugin-overview/)
-- [Staffbase Plugins SDK for Node.js](https://github.com/Staffbase/plugins-sdk-nodejs/blob/master/README.MD)
+- [Staffbase Plugins SDK for Node.js](https://github.com/Staffbase/plugins-sdk-nodejs/blob/main/README.MD)