Oclif doesn't run the commands provided

[Vanja-S]

Hello Oclif community!

I come to ask for help (this question was also asked on the oclif repo, but I figured this is a more appropriate place to ask) on a project that was recently migrated from the now deprecated oclif/command and related modules to the newest oclif version 3.x and oclif/core library. The structure of the project is pretty simple, as shown here:

my-app/
├─ bin/
│  ├─ dev
│  ├─ dev.cmd
│  ├─ run
│  ├─ run.cmd
├─ node_modules/
├─ src/
│  ├─ commands/
│  ├─ hooks/
│  ├─ lib/
│  ├─ security/
│  ├─ types/
│  ├─ command.base.ts
│  ├─ index.ts
├─ test/
├─ .gitignore
├─ other relevant files...
├─ package.json
├─ README.md
├─ yarn.lock

The app is written in typescript and compiles successfully, running (with no alias and on Win 10 env) .\bin\run only shows the help command and won't accept others that are defined in ./src/command.

Here is the tsconfig.json:

{
  "compilerOptions": {
    "declaration": true,
    "importHelpers": true,
    "module": "commonjs",
    "outDir": "lib",
    "rootDir": "src",
    "strict": true,
    "composite": true,
    "typeRoots": [".node_modules/@types"]
  },
  "include": [
    "src/**/*"
  ]
}

And the obfuscated package.json (due to the software requirements):

{
    "name": "cli-app",
    "description": "desc",
    "version": "4.8.3",
    "author": "me",
    "bin": {
        "ops": "./bin/run"
    },
    "dependencies": {
        "@azure/msal-node": "^1.14.5",
        "@oclif/core": "^2.11.8",
        "@oclif/plugin-help": "^5.2.17",
        "@oclif/plugin-not-found": "^2.3.37",
        "@oclif/plugin-warn-if-update-available": "^2.0.48",
        "axios": "^1.4.0",
        "chalk": "^5.3.0",
        "fs-extra": "^11.1.1",
        "globby": "^13.2.2",
        "gray-matter": "^4.0.3",
        "ini": "^4.1.1",
        "inquirer": "^9.2.10",
        "jira-client": "^8.2.2",
        "jszip": "^3.10.1",
        "lodash": "^4.17.11",
        "minimatch": "^9.0.3",
        "moment": "^2.24.0",
        "oauth": "^0.9.15",
        "open": "^9.1.0",
        "replace-in-file": "^4.3.1",
        "rimraf": "^2.6.3",
        "semver": "^7.5.4",
        "tough-cookie": "^4.1.3",
        "tslib": "^2.6.2",
        "yaml": "^2.3.1"
    },
    "devDependencies": {
        "@istanbuljs/nyc-config-typescript": "^1.0.2",
        "@oclif/dev-cli": "^1",
        "@oclif/test": "^1",
        "@testdeck/mocha": "^0.3.3",
        "@types/chai": "^4",
        "@types/fs-extra": "^7.0.0",
        "@types/ini": "^1.3.31",
        "@types/inquirer": "^9.0.3",
        "@types/jira-client": "^6.21.3",
        "@types/jszip": "^3.4.1",
        "@types/mocha": "^5.2.7",
        "@types/mock-fs": "^4.13.1",
        "@types/node": "^10",
        "@types/normalize-package-data": "^2.4.1",
        "@types/oauth": "^0.9.1",
        "@types/rimraf": "^2.0.2",
        "@types/semver": "^7.5.0",
        "@types/sinon": "^10.0.15",
        "chai": "^4.3.7",
        "mocha": "^10.2.0",
        "mocha-typescript": "^1.1.17",
        "mock-fs": "^5.1.1",
        "mock-spawn": "^0.2.6",
        "eslint": "^8.47.0",
        "eslint-config-oclif-typescript": "^1.0.3",
        "nock": "^13.1.3",
        "oclif": "^3.11.3",
        "nyc": "^15.1.0",
        "sinon": "^15.1.0",
        "timekeeper": "^2.2.0",
        "ts-mockito": "^2.6.1",
        "ts-node": "^10.9.1",
        "typescript": "^5.1.6"
    },
    "engines": {
        "node": "^12 || ^14 || ^16 || ^18"
    },
    "files": [
        "/bin",
        "/lib",
        "/npm-shrinkwrap.json",
        "/oclif.manifest.json"
    ],
    "homepage": "https://my.page.com",
    "keywords": [
        "operations",
        "cli"
    ],
    "license": "SEE LICENSE IN LICENSE",
    "main": "./lib/index.js",
    "oclif": {
        "bin": "ops",
        "dirname": "ops",
        "commands": "./lib/commands",
        "hook": {
            "init": "./lib/hooks/init/version-override.ts"
        },
        "plugins": [
            "@oclif/plugin-help",
            "@oclif/plugin-not-found",
            "@oclif/plugin-warn-if-update-available"
        ],
        "topics": {
            // left out on purpose
        },
        "warn-if-update-available": {
            "timeoutInDays": 1,
            "message": "cli-app update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>. If you installed using npm update by running 'npm update -g @adinsure-ops/ops-cli', otherwise update via package manager / installer package."
        }
    },
    "repository": "ops/cli-app",
    "scripts": {
        "postpack": "rimraf oclif.manifest.json",
        "prepack": "rimraf lib && tsc -b && oclif manifest",
        "test": "nyc --require ts-node/register --extension .ts mocha --timeout 20000 --forbid-only \"test/**/*.test.ts\"",
        "test-unit": "mocha \"./test/**/*.spec.ts\"",
        "test-with-coverage": "nyc --require ts-node/register --extension .ts mocha --reporter=doc --timeout 20000 --forbid-only \"test/**/*.test.ts\"",
        "test-single": "nyc --require ts-node/register --extension .ts mocha --timeout 20000 --forbid-only",
        "test-single-with-coverage": "nyc --require ts-node/register --extension .ts mocha --reporter=doc --timeout 20000 --forbid-only",
        "lint": "eslint . --ext .ts --config .eslintrc"
    },
    "types": "lib/index.d.ts"
}

also worth mentioning is that the base command class from the core library was extended to a command base class, just adding a few functions to every command, in case this is relevant to the problem, here is the CommandBase class:

import { Command, Config } from '@oclif/core';
import * as fs from 'fs-extra';
import * as path from 'path';

import SecurityContext from './security/context';

export default abstract class CommandBase extends Command {
    protected readonly security: SecurityContext;

    constructor(argv: string[], config: Config) {
        super(argv, config);
        this.security = new SecurityContext(this.config.configDir);
    }

    async getGitRoot(startDir?: string): Promise<string> {
        let currentPath = path.resolve(startDir || process.cwd());

        // tslint:disable-next-line: no-constant-condition
        while (true) {
            // We've reached the root and didn't find .git
            if (currentPath === path.parse(currentPath).root) {
                throw new Error('Not a git repository (or any of the parent directories)');
            }

            if (await fs.pathExists(path.resolve(currentPath, '.git'))) {
                // toLowerCase because of different behaviour when executing tests with yarn or with Test Explorer in VS Code
                return currentPath.toLowerCase();
            }

            currentPath = path.dirname(currentPath);
        }
    }

    async getVersion(versionFile = 'VERSION', ...filesToCheck: string[]): Promise<string> {
        filesToCheck.unshift(versionFile);
        const gitRoot = await this.getGitRoot();

        for (const file of filesToCheck) {
            const versionPath = path.resolve(gitRoot, file);
            if(await fs.pathExists(versionPath)) {
                return fs.readFileSync(versionPath, 'utf-8').trim();
            }
        }

        return this.error(`${filesToCheck} file was not found`, {exit: 2});
    }

    /**
     * Resolve path to Changelog folder from current execution directory
     */
    async getChangelogsRoot() {
        let currentPath = path.resolve(process.cwd());
        if (!await fs.pathExists(currentPath)) {
            this.log(`Directory '${currentPath}' doesn't exist ... nothing to do here.`);
            this.exit(0);
        }
        return path.resolve(currentPath, 'changelogs', 'unreleased');
    }

    /**
     * Get all files inside directory and normalize it against {baseRelativePath}.
     */
    async getFilesRecursive(dir: string, baseRelativePath: string, filter: RegExp) {
        if (!await fs.pathExists(dir)) {
            this.warn(`Directory '${dir}' doesn't exist ... nothing to do here.`);
            return [];
        }
        let relativePath = path.relative(baseRelativePath, dir);
        relativePath = relativePath === '' ? '.' : relativePath;

        const entries = await fs.readdir(dir);
        // Get files within the current directory and add a relative path to the file objects
        const files = entries
            .filter(file => !fs.statSync(path.resolve(dir, file)).isDirectory())
            .filter(file => filter.test(path.resolve(dir, file)))
            .map(file => `${relativePath}/${file}`);

        // Get folders within the current directory
        const folders = entries.filter(filetype => fs.statSync(path.resolve(dir, filetype)).isDirectory());

        for (const folder of folders)
            // Recursively call this function and get relative paths of files inside the directory
            files.push(...await this.getFilesRecursive(path.join(dir, folder), baseRelativePath, filter));
        return files;
     }
}

Here are the other "main" files that make oclif tick:
index.ts:

export { run } from '@oclif/core';

.\bin\run:

#!/usr/bin/env node

const oclif = require('@oclif/core');

oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'));

.\bin\run.cmd:

@echo off

node "%~dp0\run" %*

Thanks in advance!

[mdonnalley]

@Vanja-S Are you still experiencing this? If so, could you provide the debug output using the DEBUG=* environment variable? Thanks!