oclif / hello-world Goto Github PK

I did the following:

1. checkout of hello-world
2. npm install
3. npm run build
4. /bin/run to verify everything

So far works fine.

Now I added launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "program": "${workspaceFolder}\\bin\\run",
            "args": [
              "hello",
              "world",
            ],
        }
    ]
}

and set a breakpoint in world.ts:17 (run()).
The debugger never hits the breakpoint in the TS file.

How can I debug oclif projects in vs code?

Every time a open the CLI package the VSCode warns me about an incorrect tsconfig.json that uses project references without having composite enabled. After looking at the docs I've confirmed that VSCode is right.

Link of TS's project references docs:
https://www.typescriptlang.org/docs/handbook/project-references.html#composite

Since tests/tsconfig.json is only used by test runner we don't see any error in the console, but for long term this may cause some troube.

Some part of the template seems to be useless:

• devDependencies tslib is not referenced by any files

• The cli seems to work without src/index.ts

I've generated a CLI inside my mono-repository, and it seems like @types/mocha type declarations conflict with jest ones I use in another package. It only happens because of my environment, but it could be avoided by using the skipLibCheck option in tsconfig.json.

skipLibCheck also saves compilation time by skipping type checking dependencies.

../../../node_modules/@types/mocha/index.d.ts(2642,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'beforeEach' must be of type 'Lifecycle', but here has type 'HookFunction'.
../../../node_modules/@types/mocha/index.d.ts(2660,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'afterEach' must be of type 'Lifecycle', but here has type 'HookFunction'.
../../../node_modules/@types/mocha/index.d.ts(2676,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'describe' must be of type 'Describe', but here has type 'SuiteFunction'.
../../../node_modules/@types/mocha/index.d.ts(2697,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'xdescribe' must be of type 'Describe', but here has type 'PendingSuiteFunction'.
../../../node_modules/@types/mocha/index.d.ts(2711,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'it' must be of type 'It', but here has type 'TestFunction'.
../../../node_modules/@types/mocha/index.d.ts(2725,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'test' must be of type 'It', but here has type 'TestFunction'.
../../../node_modules/@types/mocha/index.d.ts(2732,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'xit' must be of type 'It', but here has type 'PendingTestFunction'.
../../../node_modules/@types/sass-loader/interfaces.d.ts(410,43): error TS2314: Generic type 'Options<sync>' requires 1 type argument(s).

Current template is specifically for CJS and requires modifications by the user to convert it to ESM. There are issues even after following the docs, like the tests don't pass.

We need to add a template that supports ESM without any modifications by the user and with tests that pass

The new template should be accessible through oclif's generator

Do you want to request a feature or report a bug?

This is a bug.

What is the current behavior?

Command ./bin/run hello:world not working.

Steps to reproduce -

Commands fired -

$ oclif generate stream
$ ./bin/run hello:world
Error: command hello:world not found

generate command pulls oclif/hello-world repo as a template.

What is the expected behavior?

hello world! (./src/commands/hello/world.ts)

versions-
oclif: 2.1.0
oclif/core: 1.1.0
OS: OSX 11.5.2
Node: 14.17.1