generator-verdaccio-plugin 3.0.1 → 4.0.0-next.0

package/generators/app/index.js

@@ -1,134 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
-const chalk_1 = __importDefault(require("chalk"));
-const lodash_1 = __importDefault(require("lodash"));
-const yosay = require("yosay");
-class VerdaccioPluginGenerator extends yeoman_generator_1.default {
-    constructor(args, opts) {
-        super(args, opts);
-        this.projectName = "verdaccio-";
-        this.destinationPathName = "verdaccio-";
-        this.props = {};
-    }
-    prompting() {
-        // Have Yeoman greet the user.
-        this.log(yosay("Welcome to " +
-            chalk_1.default.red("generator-verdaccio-plugin") +
-            " plugin generator!"));
-        const prompts = [
-            {
-                type: "input",
-                name: "name",
-                require: true,
-                message: "What is the name of your plugin?",
-                default: "customname",
-                validate: function (input) {
-                    return input !== "";
-                }
-            },
-            {
-                type: "list",
-                name: "lang",
-                require: true,
-                message: "Select Language",
-                default: "typescript",
-                store: true,
-                choices: [{ value: "typescript" }, { value: "javascript" }]
-            },
-            {
-                type: "list",
-                name: "pluginType",
-                require: true,
-                message: "What kind of plugin you want to create?",
-                store: true,
-                choices: [
-                    { value: "auth" },
-                    { value: "storage" },
-                    { value: "middleware" }
-                ]
-            },
-            {
-                type: "input",
-                name: "description",
-                message: "Please, describe your plugin",
-                default: "An amazing verdaccio plugin"
-            },
-            {
-                name: "githubUsername",
-                message: "GitHub username or organization",
-                validate: function (input) {
-                    return input !== "";
-                }
-            },
-            {
-                name: "authorName",
-                message: "Author's Name",
-                store: true
-            },
-            {
-                name: "authorEmail",
-                message: "Author's Email",
-                store: true
-            },
-            {
-                name: "keywords",
-                message: "Key your keywords (comma to split)",
-                filter: function (keywords) {
-                    return lodash_1.default.uniq(lodash_1.default.words(keywords).concat(["verdaccio-"]));
-                }
-            }
-        ];
-        return this.prompt(prompts).then(function (_props) {
-            // To access props later use this.props.someAnswer;
-            // @ts-ignore
-            this.props = _props;
-            const { name, githubUsername } = _props;
-            // @ts-ignore
-            this.props.license = "MIT";
-            if (githubUsername) {
-                // @ts-ignore
-                this.props.repository = githubUsername + "/" + name;
-            }
-            // @ts-ignore
-            this.projectName = `verdaccio-${name}`;
-            // @ts-ignore
-            this.destinationPathName = path_1.resolve(this.projectName);
-            // @ts-ignore
-            this.props.name = this.projectName;
-        }.bind(this));
-    }
-    packageJSON() {
-        const { lang, pluginType } = this.props;
-        const pkgJsonLocation = `${lang}/${pluginType}/_package.json`;
-        this.fs.copyTpl(this.templatePath(pkgJsonLocation), this.destinationPath(path_1.resolve(this.destinationPathName, "package.json")), this.props);
-    }
-    writing() {
-        const { lang } = this.props;
-        this.fs.copy(this.templatePath(`${lang}/common/gitignore`), this.destinationPath(path_1.resolve(this.destinationPathName, ".gitignore")));
-        this.fs.copy(this.templatePath(`${lang}/common/npmignore`), this.destinationPath(path_1.resolve(this.destinationPathName, ".npmignore")));
-        this.fs.copy(this.templatePath(`${lang}/common/jest.config.js`), this.destinationPath(path_1.resolve(this.destinationPathName, "jest.config.js")));
-        this.fs.copy(this.templatePath(`${lang}/common/babelrc`), this.destinationPath(path_1.resolve(this.destinationPathName, ".babelrc")));
-        this.fs.copy(this.templatePath(`${lang}/common/travis.yml`), this.destinationPath(path_1.resolve(this.destinationPathName, ".travis.yml")));
-        this.fs.copy(this.templatePath(`${lang}/common/travis.yml`), this.destinationPath(path_1.resolve(this.destinationPathName, ".travis.yml")));
-        this.fs.copyTpl(this.templatePath(`${lang}/common/README.md`), this.destinationPath(path_1.resolve(this.destinationPathName, "README.md")), this.props);
-        this.fs.copyTpl(this.templatePath(`${lang}/common/eslintrc`), this.destinationPath(path_1.resolve(this.destinationPathName, ".eslintrc")), this.props);
-        this.fs.copyTpl(this.templatePath(`${lang}/common/eslintignore`), this.destinationPath(path_1.resolve(this.destinationPathName, ".eslintignore")), this.props);
-        this.fs.copy(this.templatePath(`${lang}/${this.props.pluginType}/src`), this.destinationPath(path_1.resolve(this.destinationPathName, "src")), this.props);
-        this.fs.copy(this.templatePath(`${lang}/common/index.${lang == "typescript" ? "ts" : "js"}`), this.destinationPath(path_1.resolve(this.destinationPathName, `index.${lang == "typescript" ? "ts" : "js"}`)), this.props);
-        if (lang == "typescript") {
-            this.fs.copy(this.templatePath(`${lang}/common/tsconfig.json`), this.destinationPath(path_1.resolve(this.destinationPathName, "tsconfig.json")), this.props);
-            this.fs.copy(this.templatePath(`${lang}/${this.props.pluginType}/types`), this.destinationPath(path_1.resolve(this.destinationPathName, "types")), this.props);
-        }
-        this.fs.copy(this.templatePath(`${lang}/common/editorconfig`), this.destinationPath(path_1.resolve(this.destinationPathName, ".editorconfig")), this.props);
-    }
-    install() {
-        process.chdir(this.projectName);
-        this.installDependencies({ npm: true, bower: false });
-    }
-}
-exports.default = VerdaccioPluginGenerator;

package/generators/app/index.ts

@@ -1,215 +0,0 @@
-import { resolve } from "path";
-
-import Generator from "yeoman-generator";
-import chalk from "chalk";
-import _ from "lodash";
-
-import { propsTypes } from "./types";
-
-const yosay = require("yosay");
-
-export default class VerdaccioPluginGenerator extends Generator {
-  private props: propsTypes;
-  private projectName: string = "verdaccio-";
-  private destinationPathName: string = "verdaccio-";
-  constructor(args, opts) {
-    super(args, opts);
-    this.props = {};
-  }
-
-  prompting() {
-    // Have Yeoman greet the user.
-    this.log(
-      yosay(
-        "Welcome to " +
-          chalk.red("generator-verdaccio-plugin") +
-          " plugin generator!"
-      )
-    );
-
-    const prompts = [
-      {
-        type: "input",
-        name: "name",
-        require: true,
-        message: "What is the name of your plugin?",
-        default: "customname",
-        validate: function(input) {
-          return input !== "";
-        }
-      },
-      {
-        type: "list",
-        name: "lang",
-        require: true,
-        message: "Select Language",
-        default: "typescript",
-        store: true,
-        choices: [{ value: "typescript" }, { value: "javascript" }]
-      },
-      {
-        type: "list",
-        name: "pluginType",
-        require: true,
-        message: "What kind of plugin you want to create?",
-        store: true,
-        choices: [
-          { value: "auth" },
-          { value: "storage" },
-          { value: "middleware" }
-        ]
-      },
-      {
-        type: "input",
-        name: "description",
-        message: "Please, describe your plugin",
-        default: "An amazing verdaccio plugin"
-      },
-      {
-        name: "githubUsername",
-        message: "GitHub username or organization",
-        validate: function(input) {
-          return input !== "";
-        }
-      },
-      {
-        name: "authorName",
-        message: "Author's Name",
-        store: true
-      },
-      {
-        name: "authorEmail",
-        message: "Author's Email",
-        store: true
-      },
-      {
-        name: "keywords",
-        message: "Key your keywords (comma to split)",
-        filter: function(keywords) {
-          return _.uniq(_.words(keywords).concat(["verdaccio-"]));
-        }
-      }
-    ];
-
-    return this.prompt(prompts).then(
-      function(_props) {
-        // To access props later use this.props.someAnswer;
-        // @ts-ignore
-        this.props = _props;
-        const { name, githubUsername } = _props;
-        // @ts-ignore
-        this.props.license = "MIT";
-        if (githubUsername) {
-          // @ts-ignore
-          this.props.repository = githubUsername + "/" + name;
-        }
-
-        // @ts-ignore
-        this.projectName = `verdaccio-${name}`;
-
-        // @ts-ignore
-        this.destinationPathName = resolve(this.projectName);
-        // @ts-ignore
-        this.props.name = this.projectName;
-      }.bind(this)
-    );
-  }
-
-  packageJSON() {
-    const { lang, pluginType } = this.props;
-    const pkgJsonLocation = `${lang}/${pluginType}/_package.json`;
-    this.fs.copyTpl(
-      this.templatePath(pkgJsonLocation),
-      this.destinationPath(resolve(this.destinationPathName, "package.json")),
-      this.props
-    );
-  }
-
-  writing() {
-    const { lang } = this.props;
-    this.fs.copy(
-      this.templatePath(`${lang}/common/gitignore`),
-      this.destinationPath(resolve(this.destinationPathName, ".gitignore"))
-    );
-    this.fs.copy(
-      this.templatePath(`${lang}/common/npmignore`),
-      this.destinationPath(resolve(this.destinationPathName, ".npmignore"))
-    );
-    this.fs.copy(
-      this.templatePath(`${lang}/common/jest.config.js`),
-      this.destinationPath(resolve(this.destinationPathName, "jest.config.js"))
-    );
-    this.fs.copy(
-      this.templatePath(`${lang}/common/babelrc`),
-      this.destinationPath(resolve(this.destinationPathName, ".babelrc"))
-    );
-    this.fs.copy(
-      this.templatePath(`${lang}/common/travis.yml`),
-      this.destinationPath(resolve(this.destinationPathName, ".travis.yml"))
-    );
-    this.fs.copy(
-      this.templatePath(`${lang}/common/travis.yml`),
-      this.destinationPath(resolve(this.destinationPathName, ".travis.yml"))
-    );
-    this.fs.copyTpl(
-      this.templatePath(`${lang}/common/README.md`),
-      this.destinationPath(resolve(this.destinationPathName, "README.md")),
-      this.props
-    );
-    this.fs.copyTpl(
-      this.templatePath(`${lang}/common/eslintrc`),
-      this.destinationPath(resolve(this.destinationPathName, ".eslintrc")),
-      this.props
-    );
-    this.fs.copyTpl(
-      this.templatePath(`${lang}/common/eslintignore`),
-      this.destinationPath(resolve(this.destinationPathName, ".eslintignore")),
-      this.props
-    );
-
-    this.fs.copy(
-      this.templatePath(`${lang}/${this.props.pluginType}/src`),
-      this.destinationPath(resolve(this.destinationPathName, "src")),
-      this.props
-    );
-
-    this.fs.copy(
-      this.templatePath(
-        `${lang}/common/index.${lang == "typescript" ? "ts" : "js"}`
-      ),
-      this.destinationPath(
-        resolve(
-          this.destinationPathName,
-          `index.${lang == "typescript" ? "ts" : "js"}`
-        )
-      ),
-      this.props
-    );
-
-    if (lang == "typescript") {
-      this.fs.copy(
-        this.templatePath(`${lang}/common/tsconfig.json`),
-        this.destinationPath(
-          resolve(this.destinationPathName, "tsconfig.json")
-        ),
-        this.props
-      );
-      this.fs.copy(
-        this.templatePath(`${lang}/${this.props.pluginType}/types`),
-        this.destinationPath(resolve(this.destinationPathName, "types")),
-        this.props
-      );
-    }
-
-    this.fs.copy(
-      this.templatePath(`${lang}/common/editorconfig`),
-      this.destinationPath(resolve(this.destinationPathName, ".editorconfig")),
-      this.props
-    );
-  }
-
-  install() {
-    process.chdir(this.projectName);
-    this.installDependencies({ npm: true, bower: false });
-  }
-}

package/generators/app/templates/.eslintrc

@@ -1,5 +0,0 @@
-{
-	"rules": {
-		"@typescript-eslint/no-unused-vars": 0
-	}
-}

package/generators/app/templates/javascript/.eslintrc

@@ -1,5 +0,0 @@
-{
-	"rules": {
-		"no-unused-vars": 0
-	}
-}

package/generators/app/templates/javascript/auth/_package.json

@@ -1,33 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1"
-  },
-  "devDependencies": {
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0"
-  },
-  "keywords": "[<%= keywords %>]",
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/javascript/auth/src/index.js

@@ -1,35 +0,0 @@
-/**
- * Custom Verdaccio Authenticate Plugin.
- */
-class AuthCustomPlugin {
-  constructor(config, options) {
-    return this;
-  }
-  /**
-   * Authenticate an user.
-   * @param user user to log
-   * @param password provided password
-   * @param cb callback function
-   */
-  authenticate(user, password, cb) {
-    // here your code
-  }
-
-  /**
-   * check grants for such user.
-   */
-  allow_access() {
-    // in case of restrict the access
-  }
-
-  /**
-   * check grants to publish
-   */
-  allow_publish() {
-    // in cass to check if has permission to publish
-  }
-}
-
-module.exports = (config, options) => {
-  return new AuthCustomPlugin(config, options);
-};

package/generators/app/templates/javascript/common/babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@verdaccio", {typescript: false} ]
-}

package/generators/app/templates/javascript/common/eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": ["@verdaccio"]
-}

package/generators/app/templates/javascript/common/index.js

@@ -1 +0,0 @@
-module.exports = require('./lib/index.js');

package/generators/app/templates/javascript/common/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  name: 'verdaccio-<%= name %>',
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
-  transform: {
-    '^.+\\.(js|jsx|ts|tsx)$': 'babel-jest',
-  },
-  verbose: true,
-  collectCoverage: true,
-  coveragePathIgnorePatterns: ['node_modules'],
-};

package/generators/app/templates/javascript/common/travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - "8"
-  - "10"
-sudo: false
-script: npm install . && npm run test

package/generators/app/templates/javascript/middleware/_package.json

@@ -1,34 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1",
-    "express": "^4.17.1"
-  },
-  "devDependencies": {
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0"
-  },
-  "keywords": "[<%= keywords %>]",
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/javascript/middleware/src/index.js

@@ -1,8 +0,0 @@
-class VerdaccioMiddlewarePlugin {
-  constructor(config, options) {}
-  register_middlewares(app, auth, storage) {}
-}
-
-module.exports = (config, options) => {
-  return new VerdaccioMiddlewarePlugin(config, options);
-};

package/generators/app/templates/javascript/storage/_package.json

@@ -1,33 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1"
-  },
-  "devDependencies": {
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0"
-  },
-  "keywords": "[<%= keywords %>]",
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/javascript/storage/src/index.js

@@ -1 +0,0 @@
-export { default } from './plugin';

package/generators/app/templates/typescript/auth/_package.json

@@ -1,40 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1"
-  },
-  "devDependencies": {
-    "@types/jest": "^24.0.21",
-    "@types/node": "^12.12.5",
-    "@types/express": "^4.17.1",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "@verdaccio/types": "^9.5.0",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0",
-    "typescript": "^3.9.5"
-  },
-  "keywords": ["<%= keywords %>]"],
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "release": "standard-version -a -s",
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/typescript/auth/types/index.ts

@@ -1,5 +0,0 @@
-import { Config } from '@verdaccio/types';
-
-export interface CustomConfig extends Config {
-  foo: string;
-}

package/generators/app/templates/typescript/common/README.md

@@ -1,22 +0,0 @@
-# <%= name %>
-
-<%- (description || '').split('\n').map(function (line) {
-  return '> ' + line
-}).join('\n') %>
-
----
-
-## development
-
-See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. 
-Once you have completed that, use the following npm tasks.
-
-  - `npm run build`
-
-    Build a distributable archive
-
-  - `npm run test`
-
-    Run unit test
-
-For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/typescript/common/babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@verdaccio"]
-}

package/generators/app/templates/typescript/common/editorconfig

@@ -1,12 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-# 2 space indentation
-[{.,}*.{js,yml,yaml}]
-indent_style = space
-indent_size = 2

package/generators/app/templates/typescript/common/eslintignore

@@ -1,2 +0,0 @@
-node_modules
-lib

package/generators/app/templates/typescript/common/eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": ["@verdaccio"]
-}

package/generators/app/templates/typescript/common/gitignore

@@ -1,3 +0,0 @@
-npm-debug.log*
-node_modules
-/lib/

package/generators/app/templates/typescript/common/index.ts

@@ -1,3 +0,0 @@
-import VerdaccioPlugin from './lib/index';
-
-export default VerdaccioPlugin;

package/generators/app/templates/typescript/common/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  name: 'verdaccio-<%= name %>',
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
-  transform: {
-    '^.+\\.(js|jsx|ts|tsx)$': 'babel-jest',
-  },
-  verbose: true,
-  collectCoverage: true,
-  coveragePathIgnorePatterns: ['node_modules'],
-};

package/generators/app/templates/typescript/common/npmignore

@@ -1,4 +0,0 @@
-src/
-.eslintrc
-.babelrc
-test/