@staffbase/create-staffbase-plugin 1.0.1 → 1.0.6

package/.eslintrc

@@ -1,5 +1,5 @@
 {
-  "extends": "@staffbase/eslint-config-staffbase",
+  "extends": "@staffbase/eslint-config",
   "parserOptions": {
     "ecmaVersion": 6
   },

package/.github/CODEOWNERS

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

package/.github/dependabot.yml

@@ -0,0 +1,52 @@
+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: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+      timezone: "Europe/Berlin"
+    target-branch: "master"
+    open-pull-requests-limit: 10
+    labels:
+      - "github dependency"
+    reviewers:
+      - "maximizeIT"
+    commit-message:
+      prefix: chore(deps)
+    groups:
+      ga-dependencies:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+      timezone: "Europe/Berlin"
+    target-branch: "master"
+    open-pull-requests-limit: 10
+    labels:
+      - "npm dependency"
+    reviewers:
+      - "maximizeIT"
+    registries:
+      - npm-github
+    commit-message:
+      prefix: chore(deps)
+    groups:
+      npm-dependencies:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"

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

@@ -0,0 +1,10 @@
+name: Enable Dependabot Auto-Merge
+
+on: pull_request
+
+jobs:
+  dependabot:
+    uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v4.0.2
+    secrets:
+      app_id: ${{ vars.STAFFBASE_ACTIONS_APP_ID }}
+      private_key: ${{ secrets.STAFFBASE_ACTIONS_PRIVATE_KEY }}

package/README.MD

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/Staffbase/create-staffbase-plugin-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/create-staffbase-plugin-nodejs) [![Greenkeeper badge](https://badges.greenkeeper.io/Staffbase/create-staffbase-plugin-nodejs.svg)](https://greenkeeper.io/)
-
 # Create-Staffbase-SSO-CLI Documentation
 ![Staffbase Logo](https://staffbase.com/wp-content/themes/staffbase-theme/img/logo-blau.svg)
 ## Getting started
@@ -58,11 +56,12 @@ app.js
 You can also specify these values using environment variables.
 Refer to the table to see which environment variables can be used.
 
-|   *Value*   |   *Environment Variable*    |
-|:------------|:--------------------------: |
-|Secret       |STAFFBASE_SSO_SECRET         |
-|Audience     |STAFFBASE_SSO_AUDIENCE       |
-|Server Port  |PORT                         |
+|   *Value*     |   *Environment Variable*    |           *Default if not set*           |
+|:--------------|:--------------------------: |:----------------------------------------:|
+|Secret         |STAFFBASE_SSO_SECRET         | *(empty)*                                |
+|Audience       |STAFFBASE_SSO_AUDIENCE       | *(empty)*                                |
+|Server Port    |PORT                         | 3000                                     |
+|Server Address |ADDRESS                      | *(empty, listening on all IP addresses)* |
 
 ## Running the server
 _create-staffbase-plugin_ installs the project dependencies for you.
@@ -72,3 +71,22 @@ folder where your app was generated and start the express server.
 $ cd [path of generated app]
 $ npm start
 ```
+
+## License
+
+Copyright 2017-2024 Staffbase GmbH.
+
+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" />
+    </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>
+    </td>
+  </tr>
+</table>

package/csss.js

@@ -26,7 +26,7 @@ yargv
     .version('0.0.1')
     .help('help')
     .epilogue(`for more information,\please see the README at:
-    http://www.github.com/Staffbase/create-staffbase-sso-server/master/README.MD`);
+    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'));
 // Defaults package name to current folder name

package/package.json

@@ -1,20 +1,12 @@
 {
   "name": "@staffbase/create-staffbase-plugin",
-  "version": "1.0.1",
-  "bin": "./csss.js",
-  "dependencies": {
-    "colors": "^1.4.0",
-    "filepath": "^1.1.0",
-    "fs-extra": "^9.0.0",
-    "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"
+  "version": "1.0.6",
+  "bin": {
+    "create-staffbase-plugin": "csss.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Staffbase/create-staffbase-plugin-nodejs"
+    "url": "git+https://github.com/Staffbase/create-staffbase-plugin-nodejs.git"
   },
   "scripts": {
     "test": "jest",
@@ -26,14 +18,34 @@
     "parse-numbers": true,
     "boolean-negation": true
   },
+  "dependencies": {
+    "colors": "^1.4.0",
+    "filepath": "^1.1.0",
+    "fs-extra": "^9.0.0",
+    "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"
+  },
   "devDependencies": {
-    "@staffbase/eslint-config-staffbase": "^1.0.0",
-    "eslint": "^7.0.0",
+    "@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",
     "eslint-config-google": "^0.14.0",
     "highlight.js": "^10.0.3",
     "husky": "^4.2.5",
     "jest": "^26.0.1",
-    "markdown-it": "^10.0.0",
-    "marked": "^1.0.0"
+    "markdown-it": "^12.3.2",
+    "marked": "^4.0.10",
+    "typescript": "^4.9.5"
   }
 }

package/scaffoldTpl/README.MD

@@ -48,5 +48,5 @@ $ npm start
 ## Further Reading
 For getting more information about Staffbase SSO, please check out the following links:
 
-- [About Staffbase Plugin SSO](http://developers.staffbase.com/api/plugin-sso/)
-- [Staffbase Nodejs Plugin Documentation](www.github.com/staffbase/plugins-sdk-nodejs/master/README.MD)
+- [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)

package/scaffoldTpl/bin/www

@@ -9,11 +9,13 @@ var debug = require('debug')('ssosampleserver:server');
 var http = require('http');
 
 /**
- * Get port from environment and store in Express.
+ * Get port and listen address from environment and store in Express.
  */
 
 var port = normalizePort(process.env.PORT || '3000');
+var address = process.env.ADDRESS || '';
 app.set('port', port);
+app.set('address', port);
 
 /**
  * Create HTTP server.
@@ -22,10 +24,10 @@ app.set('port', port);
 var server = http.createServer(app);
 
 /**
- * Listen on provided port, on all network interfaces.
+ * Listen on provided port and network address.
  */
 
-server.listen(port, '127.0.0.1');
+server.listen(port, address);
 server.on('error', onError);
 server.on('listening', onListening);