@spinnaker/pluginsdk 0.1.0

package/LICENSE.txt

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Netflix
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Overrides } from '@spinnaker/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export{Overrides}from"@spinnaker/core";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@spinnaker/pluginsdk",
+  "description": "Provides blessed opinions (rollup, code format, lint) and packages (react, etc) to plugin developers",
+  "version": "0.1.0",
+  "module": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "scripts": {
+    "clean": "npx shx rm -rf dist",
+    "build": "spinnaker-scripts build",
+    "watch": "spinnaker-scripts start",
+    "prepublishOnly": "npm run build"
+  },
+  "bin": {
+    "check-plugin": "scripts/check-plugin.js",
+    "dev-proxy": "scripts/dev-proxy/server.js",
+    "husky-install": "scripts/husky-install.sh",
+    "restore-scaffold-file": "scripts/restore-scaffold-file.js",
+    "scaffold": "scripts/scaffold.js"
+  },
+  "dependencies": {
+    "@spinnaker/scripts": "^0.2.0",
+    "check-peer-dependencies": "^4.0.0",
+    "chokidar": "^3.5.1",
+    "express": "^4.17.1",
+    "http-proxy-middleware": "^1.0.6",
+    "husky": "^6.0.0",
+    "lint-staged": "^10.5.4",
+    "lodash": "^4.17.20",
+    "readline-sync": "^1.4.10",
+    "selfsigned": "^1.10.11",
+    "strip-json-comments": "^3.1.1",
+    "ws": "^7.4.3",
+    "yargs": "^16.2.0"
+  },
+  "devDependencies": {
+    "@spinnaker/core": "0.0.549",
+    "@types/yargs": "^16.0.0",
+    "typescript": "4.3.5"
+  },
+  "files": [
+    "dist",
+    "scaffold",
+    "scripts",
+    "pluginconfig"
+  ],
+  "gitHead": "5b8914288d87ce58b67de4720ebc623b18a3be3e"
+}

package/pluginconfig/README.md

@@ -0,0 +1,2 @@
+These config files are intended to be extended by plugins.
+The plugin should depend on `@spinnaker/pluginsdk` and extend these base configurations.

package/pluginconfig/eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['@spinnaker/eslint-plugin'],
+  extends: ['plugin:@spinnaker/base'],
+};

package/pluginconfig/huskyrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  hooks: {
+    'pre-commit': 'pretty-quick --staged',
+  },
+};

package/pluginconfig/prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'all',
+  printWidth: 120,
+};

package/pluginconfig/rollup.config.js

@@ -0,0 +1 @@
+module.exports = require('@spinnaker/scripts/config/rollup.config.base.plugin');

package/pluginconfig/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "inlineSourceMap": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "jsx": "react",
+    "lib": ["es2017", "dom", "ES2018.Promise"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "skipLibCheck": true,
+    "target": "es2017"
+  }
+}

package/scaffold/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@spinnaker/pluginsdk/pluginconfig/eslintrc');

package/scaffold/.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "src/**/*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"],
+  "src/**/*.{css,less,html}": "prettier --write"
+}

package/scaffold/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "spinnaker-deck-plugin-scaffold",
+  "version": "1.0.0",
+  "private": true,
+  "module": "build/dist/index.js",
+  "scripts": {
+    "clean": "npx shx rm -rf build",
+    "develop": "npm run clean && run-p watch proxy",
+    "build": "npm run clean && NODE_ENV=production rollup -c",
+    "lint": "eslint --ext js,jsx,ts,tsx src",
+    "postinstall": "check-plugin && check-peer-dependencies || true",
+    "prepare": "husky-install",
+    "prettier": "prettier --write 'src/**/*.{js,jsx,ts,tsx,html,css,less,json}'",
+    "proxy": "dev-proxy",
+    "watch": "rollup -c -w --no-watch.clearScreen"
+  },
+  "dependencies": {
+    "@spinnaker/pluginsdk": "latest"
+  },
+  "devDependencies": {}
+}

package/scaffold/rollup.config.js

@@ -0,0 +1,6 @@
+const basePluginConfig = require('@spinnaker/pluginsdk/pluginconfig/rollup.config');
+
+export default {
+  ...basePluginConfig,
+  input: 'src/index.ts',
+};

package/scaffold/scaffold-deck.gradle

@@ -0,0 +1 @@
+apply plugin: "io.spinnaker.plugin.ui-extension"

package/scaffold/scaffold.prettierrc.js

@@ -0,0 +1 @@
+module.exports = require('@spinnaker/pluginsdk/pluginconfig/prettierrc.js');

package/scaffold/scaffold.tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@spinnaker/pluginsdk/pluginconfig/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build/dist",
+    "rootDir": "src"
+  }
+}

package/scaffold/src/WidgetizeStage.less

@@ -0,0 +1,2 @@
+.WidgetizeStageConfig {
+}

package/scaffold/src/WidgetizeStage.tsx

@@ -0,0 +1,75 @@
+import React from 'react';
+
+import {
+  ExecutionDetailsTasks,
+  FormikFormField,
+  FormikStageConfig,
+  FormValidator,
+  HelpField,
+  IFormikStageConfigInjectedProps,
+  IStage,
+  IStageConfigProps,
+  IStageTypeConfig,
+  NumberInput,
+  TextInput,
+  Validators,
+} from '@spinnaker/core';
+
+import './WidgetizeStage.less';
+
+/** An example stage config using the FormikStageConfig component */
+export function WidgetizeStageConfig(props: IStageConfigProps) {
+  return (
+    <div className="WidgetizeStageConfig">
+      <FormikStageConfig
+        {...props}
+        validate={validate}
+        onChange={props.updateStage}
+        render={(props) => <WidgetizeStageForm {...props} />}
+      />
+    </div>
+  );
+}
+
+function WidgetizeStageForm(props: IFormikStageConfigInjectedProps) {
+  return (
+    <>
+      <FormikFormField
+        name="instanceCount"
+        label="Instance Count"
+        help={<HelpField content="The number of instances to widgetize" />}
+        input={(props) => <NumberInput {...props} />}
+      />
+
+      <FormikFormField
+        name="user.email"
+        label="User Email"
+        help={<HelpField content="The email address of the user performing the widgetize operation" />}
+        input={(props) => <TextInput {...props} />}
+      />
+    </>
+  );
+}
+
+/** Example validation */
+export function validate(stageConfig: IStage) {
+  const validator = new FormValidator(stageConfig);
+
+  validator
+    .field('count')
+    .required()
+    .withValidators((value, label) => (value < 10 ? `${label} must be > 10` : undefined));
+
+  validator.field('user.email', 'Email').required().withValidators(Validators.emailValue('Invalid email'));
+
+  return validator.validateForm();
+}
+
+export const widgetizeStage: IStageTypeConfig = {
+  key: 'widgetize',
+  label: 'Widgetize',
+  description: 'Widgetize the froobulator.',
+  component: WidgetizeStageConfig,
+  executionDetailsSections: [ExecutionDetailsTasks],
+  validateFn: validate,
+};

package/scaffold/src/index.ts

@@ -0,0 +1,6 @@
+import { IDeckPlugin } from '@spinnaker/core';
+import { widgetizeStage } from './WidgetizeStage';
+
+export const plugin: IDeckPlugin = {
+  stages: [widgetizeStage],
+};

package/scripts/check-plugin/asserters/assertFileExists.js

@@ -0,0 +1,13 @@
+const fs = require('fs');
+
+const assertFileExists = (report, filename, pristineFilename = filename) => {
+  const ok = fs.existsSync(filename);
+  const resolution = {
+    description: `restore ${filename} from scaffold defaults`,
+    command: `npx restore-scaffold-file ${filename}`,
+  };
+  report(`${filename} does not exist`, ok, resolution);
+  return ok;
+};
+
+module.exports = { assertFileExists };

package/scripts/check-plugin/asserters/assertJavascriptFile.js

@@ -0,0 +1,28 @@
+const fs = require('fs');
+const path = require('path');
+const pluginsdkdir = require('../../pluginsdkdir');
+const { assertFileExists } = require('./assertFileExists');
+
+function assertJavascriptFile(report, filename, pristineFilename, name, requireString) {
+  const exists = assertFileExists(report, filename, pristineFilename);
+
+  if (exists) {
+    // packages/pluginsdk/scaffold/${pristineFilename}
+    const pristinePath = path.resolve(pluginsdkdir, 'scaffold', pristineFilename);
+    const pristineFile = fs.readFileSync(pristinePath).toString();
+    const pluginFile = fs.readFileSync(filename).toString();
+    const hasRequire = pluginFile.includes(requireString);
+    const resolution = {
+      description: `Restore ${filename} from scaffold defaults (this will revert any local changes)`,
+      command: `npx restore-scaffold-file ${filename}`,
+    };
+    report(`${filename} does not extend ${requireString}`, hasRequire, resolution);
+    report(
+      `${filename} extends ${requireString} but has been customized`,
+      hasRequire && pristineFile.trim() !== pluginFile.trim() ? null : true,
+      resolution,
+    );
+  }
+}
+
+module.exports = { assertJavascriptFile };

package/scripts/check-plugin/asserters/assertJsonFile.js

@@ -0,0 +1,23 @@
+const { get } = require('lodash');
+
+const assertJsonFile = (report, filename, json) => {
+  return function assertJsonFile(field, expectedValue) {
+    const currentValue = get(json, field);
+
+    const deleteResolution = {
+      description: `Delete ${field} in ${filename}`,
+      command: `npx read-write-json delete "${filename}" "${field}"`,
+    };
+
+    const changeResolution = {
+      description: `Change ${field} in ${filename} from "${currentValue}" to "${expectedValue}"`,
+      command: `npx read-write-json write "${filename}" "${field}" "${expectedValue}"`,
+    };
+
+    const resolution = expectedValue === undefined ? deleteResolution : changeResolution;
+    const ok = currentValue === expectedValue;
+    report(`Unexpected value in ${filename}: ${field} should be "${expectedValue}"`, ok, resolution);
+  };
+};
+
+module.exports = { assertJsonFile };

package/scripts/check-plugin/linters/index.js

@@ -0,0 +1,9 @@
+const { checkEslintRc } = require('./lint.eslintrc');
+const { checkLintStagedRc } = require('./lint.lintstagedrc.json');
+const { checkPackageJson } = require('./lint.package.json');
+const { checkPrettierRc } = require('./lint.prettierrc');
+const { checkRollupConfig } = require('./lint.rollup.config');
+const { checkTsconfig } = require('./lint.tsconfig.json');
+
+const linters = [checkEslintRc, checkLintStagedRc, checkPackageJson, checkPrettierRc, checkRollupConfig, checkTsconfig];
+module.exports = { linters };

package/scripts/check-plugin/linters/lint.eslintrc.js

@@ -0,0 +1,13 @@
+const { assertJavascriptFile } = require('../asserters/assertJavascriptFile');
+
+function checkEslintRc(report) {
+  assertJavascriptFile(
+    report,
+    '.eslintrc.js',
+    '.eslintrc.js',
+    'Eslint config',
+    '@spinnaker/pluginsdk/pluginconfig/eslintrc',
+  );
+}
+
+module.exports = { checkEslintRc };

package/scripts/check-plugin/linters/lint.lintstagedrc.json.js

@@ -0,0 +1,7 @@
+const { assertFileExists } = require('../asserters/assertFileExists');
+
+function checkLintStagedRc(report) {
+  assertFileExists(report, '.lintstagedrc.json');
+}
+
+module.exports = { checkLintStagedRc };

package/scripts/check-plugin/linters/lint.package.json.js

@@ -0,0 +1,67 @@
+/* eslint-disable no-console */
+
+const { execSync } = require('child_process');
+const { assertJsonFile } = require('../asserters/assertJsonFile');
+const { readJson } = require('@spinnaker/scripts/read-write-json');
+
+const PLUGIN_SDK = '@spinnaker/pluginsdk';
+const PEER_DEPS = '@spinnaker/pluginsdk-peerdeps';
+
+function getLatestPackageVersion(pkg) {
+  const versionsString = execSync(`npm info ${pkg} versions`).toString();
+  return JSON.parse(versionsString.replace(/'/g, '"')).pop();
+}
+
+function getInstalledPackageVersion(pkgJson, pkg) {
+  return (
+    (pkgJson.dependencies && pkgJson.dependencies[pkg]) || (pkgJson.devDependencies && pkgJson.devDependencies[pkg])
+  );
+}
+
+function checkPackageJson(report) {
+  const pkgJson = readJson('package.json');
+
+  const latestSdkVersion = getLatestPackageVersion(PLUGIN_SDK);
+  const installedSdkVersion = getInstalledPackageVersion(pkgJson, PLUGIN_SDK);
+
+  report(
+    installedSdkVersion
+      ? `This plugin uses an out of date ${PLUGIN_SDK}@${installedSdkVersion}`
+      : `This plugin does not have ${PLUGIN_SDK} installed`,
+    installedSdkVersion === latestSdkVersion,
+    {
+      description: `Install ${PLUGIN_SDK}@${latestSdkVersion}`,
+      command: `yarn add ${PLUGIN_SDK}@${latestSdkVersion}`,
+    },
+  );
+
+  const latestPeerDepsVersion = getLatestPackageVersion(PEER_DEPS);
+  const installedPeerDepsVersion = getInstalledPackageVersion(pkgJson, PEER_DEPS);
+
+  report(
+    installedPeerDepsVersion
+      ? `This plugin uses an out of date ${PEER_DEPS}@${installedPeerDepsVersion}`
+      : `This plugin does not have ${PEER_DEPS} installed`,
+    installedPeerDepsVersion === latestPeerDepsVersion,
+    {
+      description: `Install ${PEER_DEPS}@${latestPeerDepsVersion}`,
+      command: `yarn add ${PEER_DEPS}@${latestPeerDepsVersion}`,
+    },
+  );
+
+  const checkPackageJsonField = assertJsonFile(report, 'package.json', pkgJson);
+
+  checkPackageJsonField('devDependencies.husky', undefined);
+  checkPackageJsonField('dependencies.husky', undefined);
+  checkPackageJsonField('scripts.build', 'npm run clean && NODE_ENV=production rollup -c');
+  checkPackageJsonField('scripts.clean', 'npx shx rm -rf build');
+  checkPackageJsonField('scripts.lint', 'eslint --ext js,jsx,ts,tsx src');
+  checkPackageJsonField('scripts.develop', 'npm run clean && run-p watch proxy');
+  checkPackageJsonField('scripts.postinstall', 'check-plugin && check-peer-dependencies || true');
+  checkPackageJsonField('scripts.prepare', 'husky-install');
+  checkPackageJsonField('scripts.prettier', "prettier --write 'src/**/*.{js,jsx,ts,tsx,html,css,less,json}'");
+  checkPackageJsonField('scripts.proxy', 'dev-proxy');
+  checkPackageJsonField('scripts.watch', 'rollup -c -w --no-watch.clearScreen');
+}
+
+module.exports = { checkPackageJson };

package/scripts/check-plugin/linters/lint.prettierrc.js

@@ -0,0 +1,13 @@
+const { assertJavascriptFile } = require('../asserters/assertJavascriptFile');
+
+function checkPrettierRc(report) {
+  assertJavascriptFile(
+    report,
+    '.prettierrc.js',
+    'scaffold.prettierrc.js',
+    'Prettier config',
+    '@spinnaker/pluginsdk/pluginconfig/prettierrc.js',
+  );
+}
+
+module.exports = { checkPrettierRc };

package/scripts/check-plugin/linters/lint.rollup.config.js

@@ -0,0 +1,13 @@
+const { assertJavascriptFile } = require('../asserters/assertJavascriptFile');
+
+function checkRollupConfig(report) {
+  assertJavascriptFile(
+    report,
+    'rollup.config.js',
+    'rollup.config.js',
+    'Rollup config',
+    '@spinnaker/pluginsdk/pluginconfig/rollup.config',
+  );
+}
+
+module.exports = { checkRollupConfig };

package/scripts/check-plugin/linters/lint.tsconfig.json.js

@@ -0,0 +1,19 @@
+const { assertJsonFile } = require('../asserters/assertJsonFile');
+const { assertFileExists } = require('../asserters/assertFileExists');
+const { readJson } = require('@spinnaker/scripts/read-write-json');
+
+function checkTsconfig(report) {
+  const exists = assertFileExists(report, 'tsconfig.json');
+
+  if (exists) {
+    const tsConfigJson = readJson('tsconfig.json');
+
+    const checkTsconfigField = assertJsonFile(report, 'tsconfig.json', tsConfigJson);
+
+    checkTsconfigField('extends', '@spinnaker/pluginsdk/pluginconfig/tsconfig.json');
+    checkTsconfigField('compilerOptions.outDir', 'build/dist');
+    checkTsconfigField('compilerOptions.rootDir', 'src');
+  }
+}
+
+module.exports = { checkTsconfig };

package/scripts/check-plugin.js

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+const yargs = require('yargs');
+const { execSync } = require('child_process');
+const { linters } = require('./check-plugin/linters');
+
+yargs
+  .scriptName('check-plugin')
+  .option('verbose', {
+    alias: 'v',
+    type: 'boolean',
+    default: false,
+  })
+  .option('fix', {
+    type: 'boolean',
+    alias: 'f',
+    describe: 'When enabled, fixes are automatically applied',
+    default: false,
+  })
+  .option('fix-warnings', {
+    type: 'boolean',
+    alias: 'w',
+    describe: 'When enabled, fixes are automatically applied even for warnings',
+    default: false,
+  });
+
+const { verbose, fix, fixWarnings } = yargs.argv;
+checkPlugin({ verbose, fixWarnings, fix: fix || fixWarnings });
+
+function checkPlugin(options) {
+  const { verbose, fix, fixWarnings } = options;
+
+  const errorFixers = [];
+  const warningFixers = [];
+
+  /**
+   * @param message { string }
+   * @param ok { boolean }
+   * @param resolution {{
+   *   description: string
+   *   command?: string
+   *   fixer?: Function
+   * }}
+   */
+  function reporter(message, ok, resolution = {}) {
+    const fixer = resolution.fixer || (resolution.command && (() => execSync(resolution.command)));
+
+    if (ok === true) {
+      if (verbose) {
+        console.log(`  ✅  ${message}`);
+      }
+    } else {
+      if (ok === false) {
+        console.log(`  ❌  Error: ${message}`);
+      } else {
+        console.log(`  ☑️   Warning: ${message}`);
+      }
+      if (fixer) {
+        errorFixers.push(fixer);
+        if (resolution.description) {
+          console.log(`      Fix: ${resolution.description}`);
+        }
+        if (resolution.command) {
+          console.log('      Command:');
+          console.log();
+          console.log(`        ${resolution.command}`);
+          console.log();
+        }
+      }
+    }
+  }
+
+  linters.forEach((linter) => linter(reporter));
+
+  const fixingErrors = fix && errorFixers.length;
+  const fixingWarnings = fixWarnings && warningFixers.length;
+
+  console.log();
+  console.log();
+  if (fixingErrors || fixingWarnings) {
+    if (fixingWarnings) {
+      console.log('Fixing errors and warnings...');
+    } else {
+      console.log('Fixing errors...');
+    }
+  } else if (warningFixers.length) {
+    console.log(`Run this command to auto-fix all errors and warnings:`);
+    console.log();
+    console.log(`npx check-plugin --fix-warnings`);
+  } else if (errorFixers.length) {
+    console.log(`Run this command to auto-fix all errors:`);
+    console.log();
+    console.log(`npx check-plugin --fix`);
+  }
+
+  console.log();
+  console.log();
+
+  if (fix) {
+    errorFixers.forEach((fix) => fix());
+  }
+
+  if (fixWarnings) {
+    warningFixers.forEach((fix) => fix());
+  }
+}

package/scripts/dev-proxy/certs.js

@@ -0,0 +1,75 @@
+const selfsigned = require('selfsigned');
+
+/**
+ * Generate certificates using selfsigned module.
+ *
+ * Borrowed from Webpack:
+ * https://github.com/webpack/webpack-dev-server/blob/ca36239cd845115084ca1ec8c8ff3ae10d414e86/lib/utils/createCertificate.js
+ */
+function createCertificate(attributes) {
+  return selfsigned.generate(attributes, {
+    algorithm: 'sha256',
+    days: 30,
+    keySize: 2048,
+    extensions: [
+      {
+        name: 'keyUsage',
+        keyCertSign: true,
+        digitalSignature: true,
+        nonRepudiation: true,
+        keyEncipherment: true,
+        dataEncipherment: true,
+      },
+      {
+        name: 'extKeyUsage',
+        serverAuth: true,
+        clientAuth: true,
+        codeSigning: true,
+        timeStamping: true,
+      },
+      {
+        name: 'subjectAltName',
+        altNames: [
+          {
+            // type 2 is DNS
+            type: 2,
+            value: 'localhost',
+          },
+          {
+            type: 2,
+            value: 'localhost.localdomain',
+          },
+          {
+            type: 2,
+            value: 'lvh.me',
+          },
+          {
+            type: 2,
+            value: '*.lvh.me',
+          },
+          {
+            type: 2,
+            value: '[::1]',
+          },
+          {
+            // type 7 is IP
+            type: 7,
+            ip: '127.0.0.1',
+          },
+          {
+            type: 7,
+            ip: 'fe80::1',
+          },
+        ],
+      },
+    ],
+  });
+}
+
+const certs = createCertificate([{ name: 'commonName', value: 'localhost' }]);
+const combined = certs.private + certs.cert;
+
+module.exports = {
+  key: combined,
+  cert: combined,
+};

package/scripts/dev-proxy/livereload.js

@@ -0,0 +1,54 @@
+/* eslint-disable no-console */
+const path = require('path');
+const chokidar = require('chokidar');
+const WebSocket = require('ws');
+
+// Create a websocket server on port 8999 to live reload the client
+const clients = [];
+const wss = new WebSocket.Server({ port: 8999 });
+wss.on('listening', () => {
+  console.log('Websocket (livereload) listening on localhost:8999');
+});
+wss.on('connection', (ws) => {
+  clients.push(ws);
+  ws.on('close', () => {
+    const index = clients.indexOf(ws);
+    if (index !== -1) {
+      clients.splice(index, 1);
+    }
+  });
+});
+
+const watchPath = path.resolve('build', 'dist', 'index.js');
+const watcher = chokidar.watch(watchPath);
+console.log(`Watching ${watchPath} for changes`);
+watcher.on('change', (path) => {
+  console.log(`${path} changed, reloading ${clients.length} connected browsers`);
+  clients.forEach((ws) => {
+    try {
+      if (ws.readyState === WebSocket.OPEN) {
+        ws.send('livereload');
+      }
+      ws.close();
+    } catch (error) {
+      console.error(error);
+    }
+  });
+});
+
+function liveReloadJs(req, res, next) {
+  res.set('Content-Type', 'application/javascript');
+  res.send(`
+    export const plugin = {
+      initialize() {
+        const socket = new WebSocket('ws://localhost:8999/');
+        socket.addEventListener('message', function (event) {
+          console.log('Message from server ', event.data);
+          location.reload();
+        });
+      }
+    }
+  `);
+}
+
+module.exports = liveReloadJs;

package/scripts/dev-proxy/server.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+/*********************************
+ * dev-proxy: a development proxy for doing local development on a Deck Plugin
+ * This proxy allows a Deck Plugin Developer to load their Deck plugin into an existing Spinnaker installation.
+ *
+ * Point the proxy to the URL of a live spinnaker installation.
+ * It will serve the deck assets over http://localhost:9000.
+ * It serves a custom copy of `/plugin-manifest.json` which instructs spinnaker to load the plugin assets locally.
+ * It also enables live reloading (whenever the plugin assets change) via a websocket connection between the browser and proxy.
+ *********************************/
+const express = require('express');
+const { createProxyMiddleware } = require('http-proxy-middleware');
+const fs = require('fs');
+const path = require('path');
+const http = require('http');
+const https = require('https');
+const certs = require('./certs');
+
+console.log('dev-proxy: a development proxy for doing local development on a Deck Plugin');
+console.log('This service proxies deck assets from an live deck installation and loads your Deck plugin');
+console.log();
+
+const packageJson = JSON.parse(fs.readFileSync('package.json', 'UTF-8'));
+
+const DEV_PROXY_HOST = process.env.DEV_PROXY_HOST || (packageJson.devProxy && packageJson.devProxy.host);
+
+if (!DEV_PROXY_HOST) {
+  console.error();
+  console.error();
+  console.error('Error: No Deck URL specified. Add a field to package.json:');
+  console.error();
+  console.error('"devProxy": {');
+  console.error('  "host": "https://existing.spinnaker.deck.url/"');
+  console.error('}');
+  console.error();
+  console.error('Or, to specify the proxy host on the command line:');
+  console.error();
+  console.error('DEV_PROXY_HOST=https://existing.spinnaker.deck.url/ yarn proxy');
+  console.error();
+  console.error();
+  process.exit(1);
+}
+const PLUGIN_ID = process.env.PLUGIN_ID || getPluginId();
+console.log(`pluginId: ${PLUGIN_ID}`);
+const PLUGIN_DIST_DIR = path.resolve('build', 'dist');
+
+function getPluginId() {
+  try {
+    const line = fs
+      .readFileSync(path.resolve('..', 'build.gradle'))
+      .toString()
+      .split(/\n/)
+      .find((line) => line.includes('pluginId'));
+
+    const [_, pluginId] = /pluginId\s*=\s*"([^"]+)"/.exec(line);
+    return pluginId;
+  } catch (error) {
+    console.error();
+    console.error();
+    console.error(`Error: Unable to determine pluginId from ${path.resolve('..', 'build.gradle')}`);
+    console.error(`Expected to find a line matching 'pluginId = "your.pluginid"`);
+    console.error();
+    process.exit(2);
+  }
+}
+
+const app = express();
+
+// Serve a plugin manifest with the plugin details filled in
+app.get('/plugin-manifest.json', (req, resp, next) => {
+  resp.send([
+    {
+      id: PLUGIN_ID,
+      version: '0.0.0',
+      url: `/plugindev/${PLUGIN_ID}/index.js`,
+    },
+    {
+      id: 'plugindev.livereload',
+      version: '0.0.0',
+      url: `/livereload.js`,
+    },
+  ]);
+});
+
+// Serve the plugin build via /plugindev/*
+app.use(`/plugindev/${PLUGIN_ID}/`, express.static(PLUGIN_DIST_DIR));
+
+// Send this livereload code to the client which will load it as a plugin
+app.use('/livereload.js', require('./livereload'));
+
+// Serve all other requests to deck code from an existing spinnaker environment
+app.use('/', createProxyMiddleware({ target: DEV_PROXY_HOST, changeOrigin: true }));
+
+// http
+http.createServer(app).listen(9000);
+
+// https
+https
+  .createServer(
+    {
+      key: certs.key,
+      cert: certs.cert,
+    },
+    app,
+  )
+  .listen(9443);
+
+console.log(`Server started on http://localhost:9000/`);
+console.log(`Server started on https://localhost:9443/`);

package/scripts/husky-install.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+PACKAGEDIR=$(cd $(dirname $0)/../../; pwd -P);
+cd $PACKAGEDIR;
+
+[[ ! -e package.json ]] && {
+  echo "Unable to install husky commit hooks..."
+  echo "package.json not found at $PACKAGEDIR"
+  exit
+}
+
+[[ ! -e .git ]] && [[ ! -e ../.git ]] && {
+  echo "Unable to install husky commit hooks..."
+  echo ".git not found at $PACKAGEDIR nor at $PACKAGEDIR/.."
+  exit
+}
+HUSKYBIN=$PACKAGEDIR/node_modules/.bin/husky
+
+[[ ! -e $HUSKYBIN ]] && {
+  echo "Unable to install husky commit hooks..."
+  echo "husky binary not found at $HUSKYBIN"
+  exit
+}
+
+DIRNAME=$(basename $PACKAGEDIR);
+[[ -e ../.git ]] && INSTALLDIR=".."
+[[ -e .git ]] && INSTALLDIR="."
+
+cd $INSTALLDIR
+$HUSKYBIN install
+
+cat > .husky/pre-commit <<'EOF'
+#!/usr/bin/env bash
+# CHECK THIS FILE INTO SOURCE CONTROL!
+
+. "$(dirname "$0")/_/husky.sh"
+
+EOF
+
+echo "[[ -e $DIRNAME/node_modules/.bin/lint-staged ]] && cd $DIRNAME; ./node_modules/.bin/lint-staged -p false" >> .husky/pre-commit
+chmod +x .husky/pre-commit

package/scripts/pluginsdkdir.js

@@ -0,0 +1,3 @@
+const path = require('path');
+const pluginSdkDir = path.resolve(__dirname, '..');
+module.exports = pluginSdkDir;

package/scripts/restore-scaffold-file.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+const path = require('path');
+const fs = require('fs');
+
+// Rename these files
+const fileMapping = {
+  'tsconfig.json': 'scaffold.tsconfig.json',
+  '.prettierrc.js': 'scaffold.prettierrc.js',
+  // 'scaffold-deck.gradle': `${scaffoldTargetDir}.gradle`,
+};
+
+const file = require('yargs').argv._[0];
+const sourceFile = path.resolve('node_modules', '@spinnaker', 'pluginsdk', 'scaffold', fileMapping[file] || file);
+const destFile = path.resolve('.', file);
+
+const bytes = fs.readFileSync(sourceFile);
+fs.writeFileSync(destFile, bytes);

package/scripts/scaffold.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+/* @ts-check */
+/* eslint-disable no-console */
+
+const path = require('path');
+const fs = require('fs');
+const { execSync } = require('child_process');
+const readlineSync = require('readline-sync');
+
+const yargs = require('yargs')
+  .option('directory', {
+    type: 'string',
+  })
+  .option('name', {
+    type: 'string',
+  }).argv;
+
+const pluginNameQuestion = 'Enter the short name for your plugin (default: myplugin): ';
+const pluginName = yargs.name || readlineSync.question(pluginNameQuestion, { defaultInput: 'myplugin' });
+
+const dirQuestion = `Directory to scaffold into (default: ${pluginName}-deck): `;
+const scaffoldTargetDir = yargs.directory || readlineSync.question(dirQuestion, { defaultInput: `${pluginName}-deck` });
+const basename = path.basename(path.resolve(scaffoldTargetDir));
+
+// Rename these files
+const fileMapping = {
+  'scaffold.tsconfig.json': 'tsconfig.json',
+  'scaffold.prettierrc.js': '.prettierrc.js',
+  'scaffold-deck.gradle': `${basename}.gradle`,
+};
+
+const renamedFile = (file) => fileMapping[file] || file;
+
+function mkdirIfNotExists(dirPath) {
+  if (!fs.existsSync(dirPath)) {
+    fs.mkdirSync(dirPath);
+  }
+}
+
+function recursiveCopy(srcDir, targetDir) {
+  const contents = fs.readdirSync(srcDir);
+  contents
+    .filter((x) => x !== '.' && x !== '..')
+    .forEach((file) => {
+      const srcPath = path.resolve(srcDir, file);
+      const targetPath = path.resolve(targetDir, renamedFile(file));
+      const stat = fs.statSync(srcPath);
+      if (stat.isDirectory()) {
+        mkdirIfNotExists(targetPath);
+        recursiveCopy(srcPath, targetPath);
+      } else if (stat.isFile()) {
+        fs.writeFileSync(targetPath, fs.readFileSync(srcPath));
+      }
+    });
+}
+
+function updatePackageJson(pkgJsonPath, basename) {
+  const pluginSdkPackageContents = fs.readFileSync(path.resolve(__dirname, '..', 'package.json')).toString();
+  const pluginSdkVersion = JSON.parse(pluginSdkPackageContents).version;
+  const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath).toString());
+  pkgJson.name = basename;
+  pkgJson.dependencies['@spinnaker/pluginsdk'] = pluginSdkVersion;
+  pkgJson.files = ['build/dist'];
+  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+}
+
+mkdirIfNotExists(scaffoldTargetDir);
+recursiveCopy(path.resolve(__dirname, '..', 'scaffold'), scaffoldTargetDir);
+updatePackageJson(path.resolve(scaffoldTargetDir, 'package.json'), basename);
+
+console.log(`Deck plugin scaffolded into ${scaffoldTargetDir}`);
+console.log(`Installing dependencies using 'yarn' and 'npx check-peer-dependencies --install' ...`);
+
+process.chdir(scaffoldTargetDir);
+console.log(`yarn`);
+execSync(`yarn`, { stdio: 'inherit' });
+
+console.log(`npx check-peer-dependencies --install`);
+execSync(`npx check-peer-dependencies --install`, { stdio: 'inherit' });