oclif 1.18.2-dev.2 → 2.0.0-dev.0

package/lib/generators/command.d.ts

@@ -1,15 +0,0 @@
-import * as Generator from 'yeoman-generator';
-import { Options } from '../commands/command';
-declare class CommandGenerator extends Generator {
-    options: Options;
-    pjson: any;
-    get _path(): string;
-    get _ts(): any;
-    get _ext(): "ts" | "js";
-    get _mocha(): any;
-    constructor(args: any, options: Options);
-    prompting(): Promise<void>;
-    writing(): void;
-    end(): void;
-}
-export = CommandGenerator;

package/lib/generators/command.js

@@ -1,51 +0,0 @@
-"use strict";
-const _ = require("lodash");
-const path = require("path");
-const Generator = require("yeoman-generator");
-const yosay = require("yosay");
-const { version } = require('../../package.json');
-class CommandGenerator extends Generator {
-    constructor(args, options) {
-        super(args, options);
-        this.options = options;
-    }
-    get _path() {
-        return this.options.name.split(':').join('/');
-    }
-    get _ts() {
-        return this.pjson.devDependencies.typescript;
-    }
-    get _ext() {
-        return this._ts ? 'ts' : 'js';
-    }
-    get _mocha() {
-        return this.pjson.devDependencies.mocha;
-    }
-    async prompting() {
-        this.pjson = this.fs.readJSON('package.json');
-        if (!this.pjson)
-            throw new Error('not in a project directory');
-        this.pjson.oclif = this.pjson.oclif || {};
-        this.log(yosay(`Adding a command to ${this.pjson.name} Version: ${version}`));
-    }
-    writing() {
-        this.sourceRoot(path.join(__dirname, '../../templates'));
-        let bin = this.pjson.oclif.bin || this.pjson.oclif.dirname || this.pjson.name;
-        if (bin.includes('/'))
-            bin = bin.split('/').pop();
-        const cmd = `${bin} ${this.options.name}`;
-        const commandPath = this.destinationPath(`src/commands/${this._path}.${this._ext}`);
-        const opts = Object.assign(Object.assign({}, this.options), { bin, cmd, _, type: 'command', path: commandPath });
-        this.fs.copyTpl(this.templatePath(`src/command.${this._ext}.ejs`), commandPath, opts);
-        // this.fs.copyTpl(this.templatePath(`plugin/src/hooks/init.${this._ext}`), this.destinationPath(`src/hooks/init.${this._ext}`), this)
-        if (this._mocha) {
-            // this.fs.copyTpl(this.templatePath(`plugin/test/hooks/init.test.${this._ext}`), this.destinationPath(`test/hooks/init.test.${this._ext}`), this)
-            this.fs.copyTpl(this.templatePath(`test/command.test.${this._ext}.ejs`), this.destinationPath(`test/commands/${this._path}.test.${this._ext}`), opts);
-        }
-        // this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson)
-    }
-    end() {
-        this.spawnCommandSync(path.join('.', 'node_modules/.bin/oclif-dev'), ['readme']);
-    }
-}
-module.exports = CommandGenerator;

package/lib/generators/hook.d.ts

@@ -1,14 +0,0 @@
-import * as Generator from 'yeoman-generator';
-import { Options } from '../commands/hook';
-declare class HookGenerator extends Generator {
-    options: Options;
-    pjson: any;
-    get _path(): string;
-    get _ts(): any;
-    get _ext(): "ts" | "js";
-    get _mocha(): any;
-    constructor(args: any, options: Options);
-    prompting(): Promise<void>;
-    writing(): void;
-}
-export = HookGenerator;

package/lib/generators/hook.js

@@ -1,51 +0,0 @@
-"use strict";
-const _ = require("lodash");
-const path = require("path");
-const Generator = require("yeoman-generator");
-const yosay = require("yosay");
-const { version } = require('../../package.json');
-class HookGenerator extends Generator {
-    constructor(args, options) {
-        super(args, options);
-        this.options = options;
-    }
-    get _path() {
-        return this.options.name.split(':').join('/');
-    }
-    get _ts() {
-        return this.pjson.devDependencies.typescript;
-    }
-    get _ext() {
-        return this._ts ? 'ts' : 'js';
-    }
-    get _mocha() {
-        return this.pjson.devDependencies.mocha;
-    }
-    async prompting() {
-        this.pjson = this.fs.readJSON('package.json');
-        this.pjson.oclif = this.pjson.oclif || {};
-        if (!this.pjson)
-            throw new Error('not in a project directory');
-        this.log(yosay(`Adding a ${this.options.event} hook to ${this.pjson.name} Version: ${version}`));
-    }
-    writing() {
-        this.sourceRoot(path.join(__dirname, '../../templates'));
-        this.fs.copyTpl(this.templatePath(`src/hook.${this._ext}.ejs`), this.destinationPath(`src/hooks/${this.options.event}/${this.options.name}.${this._ext}`), this);
-        if (this._mocha) {
-            this.fs.copyTpl(this.templatePath(`test/hook.test.${this._ext}.ejs`), this.destinationPath(`test/commands/${this._path}.test.${this._ext}`), this);
-        }
-        this.pjson.oclif = this.pjson.oclif || {};
-        this.pjson.oclif.hooks = this.pjson.oclif.hooks || {};
-        const hooks = this.pjson.oclif.hooks;
-        const p = `./${this._ts ? 'lib' : 'src'}/hooks/${this.options.event}/${this.options.name}`;
-        if (hooks[this.options.event]) {
-            hooks[this.options.event] = _.castArray(hooks[this.options.event]);
-            hooks[this.options.event].push(p);
-        }
-        else {
-            this.pjson.oclif.hooks[this.options.event] = p;
-        }
-        this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson);
-    }
-}
-module.exports = HookGenerator;

package/templates/LICENSE.mit

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 <%- pjson.author %>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/templates/README.md.ejs

@@ -1,21 +0,0 @@
-<%= pjson.name %>
-<%= '='.repeat(pjson.name.length) %>
-
-<%= pjson.description %>
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/<%= pjson.name %>.svg)](https://npmjs.org/package/<%= pjson.name %>)
-<%_ if (circleci) { _%>
-[![CircleCI](https://circleci.com/gh/<%= repository %>/tree/master.svg?style=shield)](https://circleci.com/gh/<%= repository %>/tree/master)
-<%_ } _%>
-<%_ if (appveyor) { _%>
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/<%= repository %>?branch=master&svg=true)](https://ci.appveyor.com/project/<%= repository %>/branch/master)
-<%_ } _%>
-[![Downloads/week](https://img.shields.io/npm/dw/<%= pjson.name %>.svg)](https://npmjs.org/package/<%= pjson.name %>)
-[![License](https://img.shields.io/npm/l/<%= pjson.name %>.svg)](https://github.com/<%= repository %>/blob/master/package.json)
-
-<!-- toc -->
-# Usage
-<!-- usage -->
-# Commands
-<!-- commands -->

package/templates/appveyor.yml.ejs

@@ -1,33 +0,0 @@
-environment:
-  nodejs_version: "10"
-cache:
-<%_ if (yarn) { _%>
-  - '%LOCALAPPDATA%\Yarn -> appveyor.yml'
-  - node_modules -> yarn.lock
-<%_ } else { _%>
-  - '%AppData%\npm-cache -> appveyor.yml'
-  - node_modules -> package-lock.json
-<%_ } _%>
-
-install:
-  - ps: Install-Product node $env:nodejs_version x64
-<%_ if (yarn) { _%>
-  - yarn
-<%_ } else { _%>
-  - npm install
-<%_ } _%>
-test_script:
-<%_ if (type === 'single' || type === 'multi') { _%>
-  - .\bin\run --version
-  - .\bin\run --help
-<%_ } else if (type === 'plugin') { _%>
-  - .\bin\run --help
-<%_ } _%>
-  - <%- yarn ? 'yarn' : 'npm' %> test
-<% if (mocha) { %>
-after_test:
-  - .\node_modules\.bin\nyc report --reporter text-lcov > coverage.lcov
-<% } %>
-
-build: off
-

package/templates/base/src/index.js

@@ -1 +0,0 @@
-exports.add = (a, b) => a + b

package/templates/base/src/index.ts

@@ -1 +0,0 @@
-export const add = (a: number, b: number) => a + b

package/templates/base/test/index.test.js

@@ -1,8 +0,0 @@
-const {expect} = require('chai')
-const {add} = require('../src')
-
-describe('add', () => {
-  it('1+2=3', () => {
-    expect(add(1, 2)).to.equal(3)
-  })
-})

package/templates/base/test/index.test.ts

@@ -1,9 +0,0 @@
-import {expect} from 'chai'
-
-import {add} from '../src'
-
-describe('add', () => {
-  it('1+2=3', () => {
-    expect(add(1, 2)).to.equal(3)
-  })
-})

package/templates/bin/run

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-require('@oclif/command').run()
-.then(require('@oclif/command/flush'))
-.catch(require('@oclif/errors/handle'))

package/templates/bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*

package/templates/circle.yml.ejs

@@ -1,65 +0,0 @@
----
-version: 2
-jobs:
-  node-latest: &test
-    docker:
-      - image: node:latest
-    working_directory: ~/cli
-    steps:
-      - checkout
-      - restore_cache: &restore_cache
-          keys:
-            - v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "<%- yarn ? 'yarn.lock' : 'package-lock.json' %>"}}
-            - v1-npm-{{checksum ".circleci/config.yml"}}
-      - run:
-          name: Install dependencies
-          command: <%- yarn ? 'yarn' : 'npm ci' %>
-      <%_ if (['single', 'multi'].includes(type)) { _%>
-      - run: ./bin/run --version
-      <%_ } _%>
-      <%_ if (['single', 'multi', 'plugin'].includes(type)) { _%>
-      - run: ./bin/run --help
-      <%_ } _%>
-      - run:
-          name: Testing
-          command: <%- yarn ? 'yarn' : 'npm' %> test
-  node-12:
-    <<: *test
-    docker:
-      - image: node:12
-  node-10:
-    <<: *test
-    docker:
-      - image: node:10
-  cache:
-    <<: *test
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: <%- yarn ? 'yarn' : 'npm ci' %>
-      - save_cache:
-          key: v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "<%- yarn ? 'yarn.lock' : 'package-lock.json' %>"}}
-          paths:
-            - ~/cli/node_modules
-            <%_ if (yarn) { _%>
-            - /usr/local/share/.cache/yarn
-            - /usr/local/share/.config/yarn
-            <%_ } else { _%>
-            - ~/.npm
-            - /usr/local/lib/node_modules
-            <%_ } _%>
-
-workflows:
-  version: 2
-  "<%= pjson.name %>":
-    jobs:
-      - node-latest
-      - node-12
-      - node-10
-      - cache:
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/

package/templates/editorconfig

@@ -1,11 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

package/templates/eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": "oclif"
-}

package/templates/eslintrc.typescript

@@ -1,12 +0,0 @@
-{
-  "extends": [
-    "oclif",
-    "oclif-typescript"
-  ],
-  "settings": {
-    "node": {
-      "tryExtensions": [".js", ".ts"]
-    }
-  },
-  "root": true
-}

package/templates/multi/src/index.js

@@ -1 +0,0 @@
-module.exports = require('@oclif/command')

package/templates/multi/src/index.ts

@@ -1 +0,0 @@
-export {run} from '@oclif/command'

package/templates/plugin/bin/run

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-require('@oclif/command').run()
-.catch(require('@oclif/errors/handle'))

package/templates/plugin/src/index.ts

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

package/templates/scripts/setup_git

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-
-if [[ ! -z "$GIT_EMAIL" ]] & [[ ! -z "$GIT_USERNAME" ]]; then
-  git config --global push.default simple
-  git config --global user.email "$GIT_EMAIL"
-  git config --global user.name "$GIT_USERNAME"
-fi
-
-git submodule sync
-git submodule update --init --recursive

package/templates/single/bin/run.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-require('..').run()
-.catch(require('@oclif/errors/handle'))

package/templates/single/bin/run.ts

@@ -1,13 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs')
-const path = require('path')
-const project = path.join(__dirname, '../tsconfig.json')
-const dev = fs.existsSync(project)
-
-if (dev) {
-  require('ts-node').register({project})
-}
-
-require(`../${dev ? 'src' : 'lib'}`).run()
-.catch(require('@oclif/errors/handle'))

package/templates/src/command.js.ejs

@@ -1,27 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-<%_ const klass = _.upperFirst(_.camelCase(name.split(':').slice(-1).join(':') + ':command')) _%>
-
-class <%- klass %> extends Command {
-  async run() {
-    const {flags} = this.parse(<%- klass %>)
-    const name = flags.name || 'world'
-    this.log(`hello ${name} from <%- path.replace(/\\/g, '\\\\') %>`)
-  }
-}
-
-<%- klass %>.description = `Describe the command here
-...
-Extra documentation goes here
-`
-
-<%- klass %>.flags = {
-<%_ if (type === 'single') { _%>
-  // add --version flag to show CLI version
-  version: flags.version({char: 'v'}),
-  // add --help flag to show CLI version
-  help: flags.help({char: 'h'}),
-<%_ } _%>
-  name: flags.string({char: 'n', description: 'name to print'}),
-}
-
-module.exports = <%- klass %>

package/templates/src/command.ts.ejs

@@ -1,46 +0,0 @@
-import {Command, flags} from '@oclif/command'
-<%_ const klass = _.upperFirst(_.camelCase(name)) _%>
-
-<%_ if (type === 'single') { _%>
-class <%- klass %> extends Command {
-<%_ } else { _%>
-export default class <%- klass %> extends Command {
-<%_ } _%>
-  static description = 'describe the command here'
-
-<%_ if (name === 'hello') { _%>
-  static examples = [
-    `$ <%- cmd %>
-hello world from ./src/<%- name %>.ts!
-`,
-  ]
-
-<%_ } _%>
-  static flags = {
-<%_ if (type === 'single') { _%>
-    // add --version flag to show CLI version
-    version: flags.version({char: 'v'}),
-<%_ } _%>
-    help: flags.help({char: 'h'}),
-    // flag with a value (-n, --name=VALUE)
-    name: flags.string({char: 'n', description: 'name to print'}),
-    // flag with no value (-f, --force)
-    force: flags.boolean({char: 'f'}),
-  }
-
-  static args = [{name: 'file'}]
-
-  async run() {
-    const {args, flags} = this.parse(<%- klass %>)
-
-    const name = flags.name ?? 'world'
-    this.log(`hello ${name} from <%- path.replace(/\\/g, '\\\\') %>`)
-    if (args.file && flags.force) {
-      this.log(`you input --force and --file: ${args.file}`)
-    }
-  }
-}
-<%_ if (type === 'single') { _%>
-
-export = <%- klass %>
-<%_ } _%>

package/templates/src/hook.js.ejs

@@ -1,3 +0,0 @@
-module.exports = async function (opts) {
-  process.stdout.write(`example hook running ${opts.id}\n`)
-}

package/templates/src/hook.ts.ejs

@@ -1,7 +0,0 @@
-import {Hook} from '@oclif/config'
-
-const hook: Hook<'<%- options.event %>'> = async function (opts) {
-  process.stdout.write(`example hook running ${opts.id}\n`)
-}
-
-export default hook

package/templates/test/command.test.js.ejs

@@ -1,28 +0,0 @@
-const {expect, test} = require('@oclif/test')
-<%_ if (type === 'single') { _%>
-const cmd = require('..')
-<%_ } _%>
-
-describe('<%- name %>', () => {
-  test
-  .stdout()
-<%_ if (type === 'single') { _%>
-  .do(() => cmd.run([]))
-<%_ } else { _%>
-  .command(['<%- name %>'])
-<%_ } _%>
-  .it('runs hello', ctx => {
-    expect(ctx.stdout).to.contain('hello world')
-  })
-
-  test
-  .stdout()
-<%_ if (type === 'single') { _%>
-  .do(() => cmd.run(['--name', 'jeff']))
-<%_ } else { _%>
-  .command(['<%- name %>', '--name', 'jeff'])
-<%_ } _%>
-  .it('runs hello --name jeff', ctx => {
-    expect(ctx.stdout).to.contain('hello jeff')
-  })
-})

package/templates/test/command.test.ts.ejs

@@ -1,29 +0,0 @@
-import {expect, test} from '@oclif/test'
-<%_ if (type === 'single') { _%>
-
-import cmd = require('../src')
-<%_ } _%>
-
-describe('<%- name %>', () => {
-  test
-  .stdout()
-<%_ if (type === 'single') { _%>
-  .do(() => cmd.run([]))
-<%_ } else { _%>
-  .command(['<%- name %>'])
-<%_ } _%>
-  .it('runs hello', ctx => {
-    expect(ctx.stdout).to.contain('hello world')
-  })
-
-  test
-  .stdout()
-<%_ if (type === 'single') { _%>
-  .do(() => cmd.run(['--name', 'jeff']))
-<%_ } else { _%>
-  .command(['<%- name %>', '--name', 'jeff'])
-<%_ } _%>
-  .it('runs hello --name jeff', ctx => {
-    expect(ctx.stdout).to.contain('hello jeff')
-  })
-})

package/templates/test/hook.test.js.ejs

@@ -1,9 +0,0 @@
-const {expect, test} = require('@oclif/test')
-
-describe('hooks', () => {
-  test
-  .stdout()
-  .hook('init', {id: 'mycommand'})
-  .do(output => expect(output.stdout).to.contain('example hook running mycommand'))
-  .it('shows a message')
-})

package/templates/test/hook.test.ts.ejs

@@ -1,9 +0,0 @@
-import {expect, test} from '@oclif/test'
-
-describe('hooks', () => {
-  test
-  .stdout()
-  .hook('init', {id: 'mycommand'})
-  .do(output => expect(output.stdout).to.contain('example hook running mycommand'))
-  .it('shows a message')
-})

package/templates/test/mocha.opts

@@ -1,4 +0,0 @@
-<%= ts ? '--require ts-node/register\n--watch-extensions ts\n' : '' _%>
---recursive
---reporter spec
---timeout 5000

package/templates/test/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "noEmit": true
-  },
-  "references": [
-    {"path": ".."}
-  ]
-}

package/templates/travis.yml.ejs

@@ -1,14 +0,0 @@
-language: node_js
-node_js:
-  - node
-
-cache: <%- yarn ? 'yarn' : 'npm' %>
-
-script:
-<%_ if (type === 'single' || type === 'multi') { _%>
-  - ./bin/run --version
-  - ./bin/run --help
-<%_ } else if (type === 'plugin') { _%>
-  - ./bin/run --help
-<%_ } _%>
-  - <%- yarn ? 'yarn' : 'npm' %> run test

package/templates/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "declaration": true,
-    "importHelpers": true,
-    "module": "commonjs",
-    "outDir": "lib",
-    "rootDir": "src",
-    "strict": true,
-    "target": "es2017"
-  },
-  "include": [
-    "src/**/*"
-  ]
-}