diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce70847c..cadc661e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ When using `./bin/balena-dev`, it is currently necessary to manually edit the `o Change from: ``` "oclif": { - "commands": "./build/actions-oclif", + "commands": "./build/commands", "hooks": { "prerun": "./build/hooks/prerun/track" ``` @@ -37,7 +37,7 @@ Change from: To: ``` "oclif": { - "commands": "./lib/actions-oclif", + "commands": "./lib/commands", "hooks": { "prerun": "./lib/hooks/prerun/track" ``` @@ -92,9 +92,9 @@ The content sources for the auto generation of `doc/cli.markdown` are: * [Selected sections](https://github.com/balena-io/balena-cli/blob/v12.23.0/automation/capitanodoc/capitanodoc.ts#L199-L204) of the README file. -* The CLI's command documentation in source code (`/lib/actions-oclif/` folder), for example: - * `lib/actions-oclif/push.ts` - * `lib/actions-oclif/env/add.ts` +* The CLI's command documentation in source code (`lib/commands/` folder), for example: + * `lib/commands/push.ts` + * `lib/commands/env/add.ts` The README file is manually edited, but subsections are automatically extracted for inclusion in `doc/cli.markdown` by the `getCapitanoDoc()` function in diff --git a/automation/build-bin.ts b/automation/build-bin.ts index cff56e07..b42d42e1 100644 --- a/automation/build-bin.ts +++ b/automation/build-bin.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import type { JsonVersions } from '../lib/actions-oclif/version'; +import type { JsonVersions } from '../lib/commands/version'; import { run as oclifRun } from '@oclif/dev-cli'; import * as archiver from 'archiver'; diff --git a/automation/capitanodoc/capitanodoc.ts b/automation/capitanodoc/capitanodoc.ts index bfc6279f..533987bf 100644 --- a/automation/capitanodoc/capitanodoc.ts +++ b/automation/capitanodoc/capitanodoc.ts @@ -31,146 +31,146 @@ const capitanoDoc = { categories: [ { title: 'API keys', - files: ['build/actions-oclif/api-key/generate.js'], + files: ['build/commands/api-key/generate.js'], }, { title: 'Application', files: [ - 'build/actions-oclif/apps.js', - 'build/actions-oclif/app/index.js', - 'build/actions-oclif/app/create.js', - 'build/actions-oclif/app/rm.js', - 'build/actions-oclif/app/rename.js', - 'build/actions-oclif/app/restart.js', + 'build/commands/apps.js', + 'build/commands/app/index.js', + 'build/commands/app/create.js', + 'build/commands/app/rm.js', + 'build/commands/app/rename.js', + 'build/commands/app/restart.js', ], }, { title: 'Authentication', files: [ - 'build/actions-oclif/login.js', - 'build/actions-oclif/logout.js', - 'build/actions-oclif/whoami.js', + 'build/commands/login.js', + 'build/commands/logout.js', + 'build/commands/whoami.js', ], }, { title: 'Device', files: [ - 'build/actions-oclif/device/identify.js', - 'build/actions-oclif/device/init.js', - 'build/actions-oclif/device/index.js', - 'build/actions-oclif/device/move.js', - 'build/actions-oclif/device/reboot.js', - 'build/actions-oclif/device/register.js', - 'build/actions-oclif/device/rename.js', - 'build/actions-oclif/device/rm.js', - 'build/actions-oclif/device/restart.js', - 'build/actions-oclif/device/shutdown.js', - 'build/actions-oclif/devices/index.js', - 'build/actions-oclif/devices/supported.js', - 'build/actions-oclif/device/os-update.js', - 'build/actions-oclif/device/public-url.js', + 'build/commands/device/identify.js', + 'build/commands/device/init.js', + 'build/commands/device/index.js', + 'build/commands/device/move.js', + 'build/commands/device/reboot.js', + 'build/commands/device/register.js', + 'build/commands/device/rename.js', + 'build/commands/device/rm.js', + 'build/commands/device/restart.js', + 'build/commands/device/shutdown.js', + 'build/commands/devices/index.js', + 'build/commands/devices/supported.js', + 'build/commands/device/os-update.js', + 'build/commands/device/public-url.js', ], }, { title: 'Environment Variables', files: [ - 'build/actions-oclif/envs.js', - 'build/actions-oclif/env/add.js', - 'build/actions-oclif/env/rename.js', - 'build/actions-oclif/env/rm.js', + 'build/commands/envs.js', + 'build/commands/env/add.js', + 'build/commands/env/rename.js', + 'build/commands/env/rm.js', ], }, { title: 'Tags', files: [ - 'build/actions-oclif/tags.js', - 'build/actions-oclif/tag/rm.js', - 'build/actions-oclif/tag/set.js', + 'build/commands/tags.js', + 'build/commands/tag/rm.js', + 'build/commands/tag/set.js', ], }, { title: 'Help and Version', - files: ['help', 'build/actions-oclif/version.js'], + files: ['help', 'build/commands/version.js'], }, { title: 'Keys', files: [ - 'build/actions-oclif/keys.js', - 'build/actions-oclif/key/index.js', - 'build/actions-oclif/key/add.js', - 'build/actions-oclif/key/rm.js', + 'build/commands/keys.js', + 'build/commands/key/index.js', + 'build/commands/key/add.js', + 'build/commands/key/rm.js', ], }, { title: 'Logs', - files: ['build/actions-oclif/logs.js'], + files: ['build/commands/logs.js'], }, { title: 'Network', files: [ - 'build/actions-oclif/scan.js', - 'build/actions-oclif/ssh.js', - 'build/actions-oclif/tunnel.js', + 'build/commands/scan.js', + 'build/commands/ssh.js', + 'build/commands/tunnel.js', ], }, { title: 'Notes', - files: ['build/actions-oclif/note.js'], + files: ['build/commands/note.js'], }, { title: 'OS', files: [ - 'build/actions-oclif/os/build-config.js', - 'build/actions-oclif/os/configure.js', - 'build/actions-oclif/os/versions.js', - 'build/actions-oclif/os/download.js', - 'build/actions-oclif/os/initialize.js', + 'build/commands/os/build-config.js', + 'build/commands/os/configure.js', + 'build/commands/os/versions.js', + 'build/commands/os/download.js', + 'build/commands/os/initialize.js', ], }, { title: 'Config', files: [ - 'build/actions-oclif/config/generate.js', - 'build/actions-oclif/config/inject.js', - 'build/actions-oclif/config/read.js', - 'build/actions-oclif/config/reconfigure.js', - 'build/actions-oclif/config/write.js', + 'build/commands/config/generate.js', + 'build/commands/config/inject.js', + 'build/commands/config/read.js', + 'build/commands/config/reconfigure.js', + 'build/commands/config/write.js', ], }, { title: 'Preload', - files: ['build/actions-oclif/preload.js'], + files: ['build/commands/preload.js'], }, { title: 'Push', - files: ['build/actions-oclif/push.js'], + files: ['build/commands/push.js'], }, { title: 'Settings', - files: ['build/actions-oclif/settings.js'], + files: ['build/commands/settings.js'], }, { title: 'Local', files: [ - 'build/actions-oclif/local/configure.js', - 'build/actions-oclif/local/flash.js', + 'build/commands/local/configure.js', + 'build/commands/local/flash.js', ], }, { title: 'Deploy', - files: ['build/actions-oclif/build.js', 'build/actions-oclif/deploy.js'], + files: ['build/commands/build.js', 'build/commands/deploy.js'], }, { title: 'Platform', - files: ['build/actions-oclif/join.js', 'build/actions-oclif/leave.js'], + files: ['build/commands/join.js', 'build/commands/leave.js'], }, { title: 'Utilities', - files: ['build/actions-oclif/util/available-drives.js'], + files: ['build/commands/util/available-drives.js'], }, { title: 'Support', - files: ['build/actions-oclif/support.js'], + files: ['build/commands/support.js'], }, ], }; diff --git a/lib/actions-oclif/api-key/generate.ts b/lib/commands/api-key/generate.ts similarity index 100% rename from lib/actions-oclif/api-key/generate.ts rename to lib/commands/api-key/generate.ts diff --git a/lib/actions-oclif/app/create.ts b/lib/commands/app/create.ts similarity index 100% rename from lib/actions-oclif/app/create.ts rename to lib/commands/app/create.ts diff --git a/lib/actions-oclif/app/index.ts b/lib/commands/app/index.ts similarity index 100% rename from lib/actions-oclif/app/index.ts rename to lib/commands/app/index.ts diff --git a/lib/actions-oclif/app/rename.ts b/lib/commands/app/rename.ts similarity index 100% rename from lib/actions-oclif/app/rename.ts rename to lib/commands/app/rename.ts diff --git a/lib/actions-oclif/app/restart.ts b/lib/commands/app/restart.ts similarity index 100% rename from lib/actions-oclif/app/restart.ts rename to lib/commands/app/restart.ts diff --git a/lib/actions-oclif/app/rm.ts b/lib/commands/app/rm.ts similarity index 100% rename from lib/actions-oclif/app/rm.ts rename to lib/commands/app/rm.ts diff --git a/lib/actions-oclif/apps.ts b/lib/commands/apps.ts similarity index 100% rename from lib/actions-oclif/apps.ts rename to lib/commands/apps.ts diff --git a/lib/actions-oclif/build.ts b/lib/commands/build.ts similarity index 100% rename from lib/actions-oclif/build.ts rename to lib/commands/build.ts diff --git a/lib/actions-oclif/config/generate.ts b/lib/commands/config/generate.ts similarity index 100% rename from lib/actions-oclif/config/generate.ts rename to lib/commands/config/generate.ts diff --git a/lib/actions-oclif/config/inject.ts b/lib/commands/config/inject.ts similarity index 100% rename from lib/actions-oclif/config/inject.ts rename to lib/commands/config/inject.ts diff --git a/lib/actions-oclif/config/read.ts b/lib/commands/config/read.ts similarity index 100% rename from lib/actions-oclif/config/read.ts rename to lib/commands/config/read.ts diff --git a/lib/actions-oclif/config/reconfigure.ts b/lib/commands/config/reconfigure.ts similarity index 100% rename from lib/actions-oclif/config/reconfigure.ts rename to lib/commands/config/reconfigure.ts diff --git a/lib/actions-oclif/config/write.ts b/lib/commands/config/write.ts similarity index 100% rename from lib/actions-oclif/config/write.ts rename to lib/commands/config/write.ts diff --git a/lib/actions-oclif/deploy.ts b/lib/commands/deploy.ts similarity index 100% rename from lib/actions-oclif/deploy.ts rename to lib/commands/deploy.ts diff --git a/lib/actions-oclif/device/identify.ts b/lib/commands/device/identify.ts similarity index 100% rename from lib/actions-oclif/device/identify.ts rename to lib/commands/device/identify.ts diff --git a/lib/actions-oclif/device/index.ts b/lib/commands/device/index.ts similarity index 100% rename from lib/actions-oclif/device/index.ts rename to lib/commands/device/index.ts diff --git a/lib/actions-oclif/device/init.ts b/lib/commands/device/init.ts similarity index 100% rename from lib/actions-oclif/device/init.ts rename to lib/commands/device/init.ts diff --git a/lib/actions-oclif/device/move.ts b/lib/commands/device/move.ts similarity index 100% rename from lib/actions-oclif/device/move.ts rename to lib/commands/device/move.ts diff --git a/lib/actions-oclif/device/os-update.ts b/lib/commands/device/os-update.ts similarity index 100% rename from lib/actions-oclif/device/os-update.ts rename to lib/commands/device/os-update.ts diff --git a/lib/actions-oclif/device/public-url.ts b/lib/commands/device/public-url.ts similarity index 100% rename from lib/actions-oclif/device/public-url.ts rename to lib/commands/device/public-url.ts diff --git a/lib/actions-oclif/device/reboot.ts b/lib/commands/device/reboot.ts similarity index 100% rename from lib/actions-oclif/device/reboot.ts rename to lib/commands/device/reboot.ts diff --git a/lib/actions-oclif/device/register.ts b/lib/commands/device/register.ts similarity index 100% rename from lib/actions-oclif/device/register.ts rename to lib/commands/device/register.ts diff --git a/lib/actions-oclif/device/rename.ts b/lib/commands/device/rename.ts similarity index 100% rename from lib/actions-oclif/device/rename.ts rename to lib/commands/device/rename.ts diff --git a/lib/actions-oclif/device/restart.ts b/lib/commands/device/restart.ts similarity index 100% rename from lib/actions-oclif/device/restart.ts rename to lib/commands/device/restart.ts diff --git a/lib/actions-oclif/device/rm.ts b/lib/commands/device/rm.ts similarity index 100% rename from lib/actions-oclif/device/rm.ts rename to lib/commands/device/rm.ts diff --git a/lib/actions-oclif/device/shutdown.ts b/lib/commands/device/shutdown.ts similarity index 100% rename from lib/actions-oclif/device/shutdown.ts rename to lib/commands/device/shutdown.ts diff --git a/lib/actions-oclif/devices/index.ts b/lib/commands/devices/index.ts similarity index 100% rename from lib/actions-oclif/devices/index.ts rename to lib/commands/devices/index.ts diff --git a/lib/actions-oclif/devices/supported.ts b/lib/commands/devices/supported.ts similarity index 100% rename from lib/actions-oclif/devices/supported.ts rename to lib/commands/devices/supported.ts diff --git a/lib/actions-oclif/env/add.ts b/lib/commands/env/add.ts similarity index 100% rename from lib/actions-oclif/env/add.ts rename to lib/commands/env/add.ts diff --git a/lib/actions-oclif/env/rename.ts b/lib/commands/env/rename.ts similarity index 100% rename from lib/actions-oclif/env/rename.ts rename to lib/commands/env/rename.ts diff --git a/lib/actions-oclif/env/rm.ts b/lib/commands/env/rm.ts similarity index 100% rename from lib/actions-oclif/env/rm.ts rename to lib/commands/env/rm.ts diff --git a/lib/actions-oclif/envs.ts b/lib/commands/envs.ts similarity index 100% rename from lib/actions-oclif/envs.ts rename to lib/commands/envs.ts diff --git a/lib/actions-oclif/internal/osinit.ts b/lib/commands/internal/osinit.ts similarity index 100% rename from lib/actions-oclif/internal/osinit.ts rename to lib/commands/internal/osinit.ts diff --git a/lib/actions-oclif/internal/scandevices.ts b/lib/commands/internal/scandevices.ts similarity index 100% rename from lib/actions-oclif/internal/scandevices.ts rename to lib/commands/internal/scandevices.ts diff --git a/lib/actions-oclif/join.ts b/lib/commands/join.ts similarity index 100% rename from lib/actions-oclif/join.ts rename to lib/commands/join.ts diff --git a/lib/actions-oclif/key/add.ts b/lib/commands/key/add.ts similarity index 100% rename from lib/actions-oclif/key/add.ts rename to lib/commands/key/add.ts diff --git a/lib/actions-oclif/key/index.ts b/lib/commands/key/index.ts similarity index 100% rename from lib/actions-oclif/key/index.ts rename to lib/commands/key/index.ts diff --git a/lib/actions-oclif/key/rm.ts b/lib/commands/key/rm.ts similarity index 100% rename from lib/actions-oclif/key/rm.ts rename to lib/commands/key/rm.ts diff --git a/lib/actions-oclif/keys.ts b/lib/commands/keys.ts similarity index 100% rename from lib/actions-oclif/keys.ts rename to lib/commands/keys.ts diff --git a/lib/actions-oclif/leave.ts b/lib/commands/leave.ts similarity index 100% rename from lib/actions-oclif/leave.ts rename to lib/commands/leave.ts diff --git a/lib/actions-oclif/local/configure.ts b/lib/commands/local/configure.ts similarity index 100% rename from lib/actions-oclif/local/configure.ts rename to lib/commands/local/configure.ts diff --git a/lib/actions-oclif/local/flash.ts b/lib/commands/local/flash.ts similarity index 100% rename from lib/actions-oclif/local/flash.ts rename to lib/commands/local/flash.ts diff --git a/lib/actions-oclif/login.ts b/lib/commands/login.ts similarity index 100% rename from lib/actions-oclif/login.ts rename to lib/commands/login.ts diff --git a/lib/actions-oclif/logout.ts b/lib/commands/logout.ts similarity index 100% rename from lib/actions-oclif/logout.ts rename to lib/commands/logout.ts diff --git a/lib/actions-oclif/logs.ts b/lib/commands/logs.ts similarity index 100% rename from lib/actions-oclif/logs.ts rename to lib/commands/logs.ts diff --git a/lib/actions-oclif/note.ts b/lib/commands/note.ts similarity index 100% rename from lib/actions-oclif/note.ts rename to lib/commands/note.ts diff --git a/lib/actions-oclif/os/build-config.ts b/lib/commands/os/build-config.ts similarity index 100% rename from lib/actions-oclif/os/build-config.ts rename to lib/commands/os/build-config.ts diff --git a/lib/actions-oclif/os/configure.ts b/lib/commands/os/configure.ts similarity index 100% rename from lib/actions-oclif/os/configure.ts rename to lib/commands/os/configure.ts diff --git a/lib/actions-oclif/os/download.ts b/lib/commands/os/download.ts similarity index 100% rename from lib/actions-oclif/os/download.ts rename to lib/commands/os/download.ts diff --git a/lib/actions-oclif/os/initialize.ts b/lib/commands/os/initialize.ts similarity index 100% rename from lib/actions-oclif/os/initialize.ts rename to lib/commands/os/initialize.ts diff --git a/lib/actions-oclif/os/versions.ts b/lib/commands/os/versions.ts similarity index 100% rename from lib/actions-oclif/os/versions.ts rename to lib/commands/os/versions.ts diff --git a/lib/actions-oclif/preload.ts b/lib/commands/preload.ts similarity index 100% rename from lib/actions-oclif/preload.ts rename to lib/commands/preload.ts diff --git a/lib/actions-oclif/push.ts b/lib/commands/push.ts similarity index 100% rename from lib/actions-oclif/push.ts rename to lib/commands/push.ts diff --git a/lib/actions-oclif/scan.ts b/lib/commands/scan.ts similarity index 100% rename from lib/actions-oclif/scan.ts rename to lib/commands/scan.ts diff --git a/lib/actions-oclif/settings.ts b/lib/commands/settings.ts similarity index 100% rename from lib/actions-oclif/settings.ts rename to lib/commands/settings.ts diff --git a/lib/actions-oclif/ssh.ts b/lib/commands/ssh.ts similarity index 100% rename from lib/actions-oclif/ssh.ts rename to lib/commands/ssh.ts diff --git a/lib/actions-oclif/support.ts b/lib/commands/support.ts similarity index 100% rename from lib/actions-oclif/support.ts rename to lib/commands/support.ts diff --git a/lib/actions-oclif/tag/rm.ts b/lib/commands/tag/rm.ts similarity index 100% rename from lib/actions-oclif/tag/rm.ts rename to lib/commands/tag/rm.ts diff --git a/lib/actions-oclif/tag/set.ts b/lib/commands/tag/set.ts similarity index 100% rename from lib/actions-oclif/tag/set.ts rename to lib/commands/tag/set.ts diff --git a/lib/actions-oclif/tags.ts b/lib/commands/tags.ts similarity index 100% rename from lib/actions-oclif/tags.ts rename to lib/commands/tags.ts diff --git a/lib/actions-oclif/tunnel.ts b/lib/commands/tunnel.ts similarity index 100% rename from lib/actions-oclif/tunnel.ts rename to lib/commands/tunnel.ts diff --git a/lib/actions-oclif/util/available-drives.ts b/lib/commands/util/available-drives.ts similarity index 100% rename from lib/actions-oclif/util/available-drives.ts rename to lib/commands/util/available-drives.ts diff --git a/lib/actions-oclif/version.ts b/lib/commands/version.ts similarity index 100% rename from lib/actions-oclif/version.ts rename to lib/commands/version.ts diff --git a/lib/actions-oclif/whoami.ts b/lib/commands/whoami.ts similarity index 100% rename from lib/actions-oclif/whoami.ts rename to lib/commands/whoami.ts diff --git a/package.json b/package.json index e5d878c6..46af63f7 100644 --- a/package.json +++ b/package.json @@ -100,7 +100,7 @@ }, "oclif": { "bin": "balena", - "commands": "./build/actions-oclif", + "commands": "./build/commands", "helpClass": "./build/help", "hooks": { "prerun": "./build/hooks/prerun/track",