Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More v3 features #772

Merged
merged 82 commits into from
Aug 31, 2023
Merged

More v3 features #772

merged 82 commits into from
Aug 31, 2023

Conversation

mdonnalley
Copy link
Contributor

@mdonnalley mdonnalley commented Aug 29, 2023

BREAKING CHANGES ❗

Dropping node 14 and node 16 support

The end-of-life date for Node.js 14 was April 30, 2023.

The end-of-life date for Node.js 16 is September 11, 2023. This date is earlier than previously published. Node.js’s blog explains why they chose this earlier end-of-life date.

Config.plugins

Config.plugins is now a Map where the keys are the plugin names and the values are the loaded Plugin instances. Previously it was an array of loaded Plugin instances.

By using a Map we can now do more efficient lookups during command execution. Config.getPluginsList was added in case you still would like a flat array of Plugin instances.

Readonly properties on Config

Various properties on Config are now readonly
- name
- version
- channel
- pjson
- root
- arch
- bin
- cacheDir
- configDir
- dataDir
- dirname
- errLog
- home
- platform
- shell
- userAgent
- windows
- debug
- npmRegistry
- userPJSON
- plugins
- binPath
- binAliases
- nsisCustomization
- valid
- flexibleTaxonomy
- commands

Private methods on Plugin

The _manifest and warn methods on Plugin are now private

ux exports

The following exports are no longer available on ux:

  • ActionBase
  • config
  • Config
  • ExitError
  • IPromptOptions
  • Table

If you still need these you can import them from @oclif/core/ux:

import {
  ActionBase,
  config,
  Config,
  ExitError,
  IPromptOptions,
  Table,
} from '@oclif/core/ux'

global['cli-ux'] -> global.ux

The global cli-ux object has been renamed to ux to be consistent with the module's name

handle

The exported handle function for handling errors in bin scripts is now asynchronous

noCacheDefault flag property replaces isWritingManifest

Version 2 allowed you to optionally return non-sensitive input if the default or defaultHelp flag/arg properties were called during manifest creation. This is helpful if you don't want sensitive data to be put into the oclif.manifest.json and then released to npm. To do this you had to handle the isWritingManifest parameter passed in to the default and defaultHelp callbacks.

export const mySensitiveFlag = Flags.string({
  default: async (context, isWritingManifest) => {
    if (isWritingManifest) {
      return undefined;
    }
    
    return 'sensitive info'
  },
});

Version 3 removes the isWritingManifest parameter in favor of a flag and arg property, noCacheDefault. Setting it to true will automatically keep it from being cached in the manfiest.

export const mySensitiveFlag = Flags.string({
  noCacheDefault: true,
  default: async (context) => {
    return 'sensitive info'
  },
});

Features 🎉

Exports

The exports property in the package.json are now used for exporting individual pieces of functionality.

The main export should continue to work as it did in v2:

import {Interfaces, ux} from '@oclif/core'

But you can now import individual modules if desired:

import Interfaces from '@oclif/core/interfaces'
import ux from '@oclif/core/ux'

These are the exports that are available:
@oclif/core/execute
@oclif/core/flush
@oclif/core/handle
@oclif/core/interfaces
@oclif/core/run
@oclif/core/settings
@oclif/core/ux

You will need to set moduleResolution to Node16 in your tsconfig.json to use this feature.

Cache Flexible taxonomy Command Permutations

The command permutations for flexible taxonomy are now cached in the oclif.manifest.json allowing for quicker startup times.

Base automatically changed from mdonnalley/esm-support to prerelease/v3 August 31, 2023 16:53
@mdonnalley mdonnalley merged commit 6affd92 into prerelease/v3 Aug 31, 2023
13 of 25 checks passed
@mdonnalley mdonnalley deleted the mdonnalley/exports branch August 31, 2023 17:25
mdonnalley added a commit that referenced this pull request Oct 4, 2023
* chore: v3 prerelease branch

* chore(release): 3.0.0-beta.1 [skip ci]

* feat: ESM support (#759)

* fix: set moduleResolution to Node16

* fix: use file urls

* chore: add types

* feat: support linking CJS plugins into ESM plugins

* chore: integration tests for module interoperability

* test: add CJS/ESM interoperability tests

* fix: e2e tests

* test: isolate cache, config, and data dir for e2e tests

* test: test bug

* test: make less noisy

* test: esm/cjs hooks

* chore: parallelize e2e tests

* chore: typo

* test: parallelize e2e tests

* test: no more hanging tests

* chore: un-parallelize esm-cjs tests

* chore: add DEBUG to esm-cjs interop tests

* chore: add DEBUG to esm-cjs interop tests

* chore: try enabling debug again

* test: fix node 20 tests

* chore: update DEBUG env var

* chore: debug tests

* chore: debug tests

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: use path.join

* test: stop using replace-in-file

* chore: more test debugging

* fix: use path.join when registering ts-node

* test: run in parallel

* test: run tests serially

* fix: dont remove undefined values from tsconfig

* fix: further isolate ts-configs

* feat: throw error when loading ESM paths from linked plugins

* fix: default esm to true

* test: compilation errors

* feat: better developer experience

* fix: add getPluginsList

* chore(release): 2.11.9 [skip ci]

* fix: add getPluginsList to Config interface

* chore(release): 2.11.10 [skip ci]

---------

Co-authored-by: svc-cli-bot <[email protected]>

* chore(release): 3.0.0-beta.2 [skip ci]

* More v3 features (#772)

* fix: set moduleResolution to Node16

* fix: use file urls

* chore: add types

* feat: support linking CJS plugins into ESM plugins

* chore: integration tests for module interoperability

* test: add CJS/ESM interoperability tests

* fix: e2e tests

* test: isolate cache, config, and data dir for e2e tests

* test: test bug

* test: make less noisy

* test: esm/cjs hooks

* chore: parallelize e2e tests

* chore: typo

* test: parallelize e2e tests

* test: no more hanging tests

* chore: un-parallelize esm-cjs tests

* chore: add DEBUG to esm-cjs interop tests

* chore: add DEBUG to esm-cjs interop tests

* chore: try enabling debug again

* test: fix node 20 tests

* chore: update DEBUG env var

* chore: debug tests

* chore: debug tests

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: more debugging

* test: use path.join

* test: stop using replace-in-file

* chore: more test debugging

* fix: use path.join when registering ts-node

* test: run in parallel

* test: run tests serially

* fix: dont remove undefined values from tsconfig

* fix: further isolate ts-configs

* feat: throw error when loading ESM paths from linked plugins

* fix: default esm to true

* test: compilation errors

* feat: better developer experience

* fix: add getPluginsList

* chore(release): 2.11.9 [skip ci]

* fix: add getPluginsList to Config interface

* chore(release): 2.11.10 [skip ci]

* feat: use exports

* fix: ux class

* fix: add exports for help and perf

* chore: tests

* feat: use Map for config.plugins

* feat: add noCacheDefault

* feat: add exports for Args and Flags

* chore: fix tests

* feat: put permutations into manifest

* fix: add return to execute

* fix: add version to PJSON interface

* feat: drop node 14 and 16 support

* fix: use CLIError for integer flag errors

* fix: skip findRoot for linked plugins

* chore: remove console.log

* fix: dont load core plugin if already loaded as linked or user plugin

* fix: ux export

* chore: making things readonly

* feat: add config export

* test: make tests passing again

* feat: rename cli-ux global to ux global

* chore: go back to node 16 support

* chore: migration guide

* chore: remove source-map register

* test: remove resolution

* chore: update migration guide

* fix: revert link findRoot optimization

* fix: remove unneeded exports

* feat: add PluginLoader

* chore: update migration guide

* chore: merge conflict

* chore: more merge conflicts

* test: recursive mkdir

---------

Co-authored-by: svc-cli-bot <[email protected]>

* chore(release): 3.0.0-beta.3 [skip ci]

* chore(release): 3.0.0-beta.4 [skip ci]

* fix: add main to package.json

* chore(release): 3.0.0-beta.5 [skip ci]

* fix: export CustomOptions

* chore(release): 3.0.0-beta.6 [skip ci]

* fix: interface exports

* chore(release): 3.0.0-beta.7 [skip ci]

* feat: remove ux and interfaces export

* chore(release): 3.0.0-beta.8 [skip ci]

* fix: revert ux changes

* chore(release): 3.0.0-beta.9 [skip ci]

* feat: revert exports changes (#776)

* feat: revert exports changes

* fix: run e2e tests even if linting error

* fix: revert cli-ux dir renaming

* chore(release): 3.0.0-beta.10 [skip ci]

* fix: revert styledJSON change

* chore(release): 3.0.0-beta.11 [skip ci]

* fix: update imports in Config

* chore(release): 3.0.0-beta.12 [skip ci]

* feat: skip ts-node register for ESM plugins (#778)

* feat: skip ts-node register for ESM plugins

* chore: update debug message

* chore(release): 3.0.0-beta.13 [skip ci]

* feat: final v3 features (#779)

* feat: add charAliases

* feat: add Flags.option

* fix: undo default options

* fix: allow bin/dev.js to auto-transpile ESM plugin

* chore: update execute examples

* fix: update tsnode skip logic

* chore: test debugging

* fix: ts-node skip logic

* fix: ts-node skip logic

* feat: cache relativePath and isESM in manifest

* fix: calculate id permutations at runtime to support backwards compatability

* perf: avoid findLegacyRoot for linked plugins

* chore: remove env var

* fix: improve perf metrics

* perf: improve perf debug output

* perf: more debug improvements

* test: compilation errors

* fix: make relativePath OS safe

* test: use sf esm branch

* perf: give full hook path

* chore: test debugging

* chore: test debugging

* chore: test debugging

* test: set shell for e2e tests

* fix: flag types respect defaults

* feat: node protocol

* test: move windows sf integration tests into separate job

* test: update assertion on plugins install test

* test: use correct file path

* test: use -Force

* test: use bash shell

* test: clean up

* test: remove shell option

* test: oclif/config, core v1, and core v2 interop tests

* chore: drop node 16

* test: remove lts/-1

* chore: code review

* chore: add pre core migration guide

* refactor: break up ModuleLoader

* chore: remove unicorn/consistent-function-scoping

* chore: remove unicorn/no-missing-imports

* chore: remove @typescript-eslint/no-empty-function

* chore: remove ban-ts-comment and ban-ts-ignore

* chore: add sort-import rule

* fix: throw error if non-multiple flag provided more than once

* test: mutliples of non-multiple flag test

* test: ut for charAliases (#791)

* test: duplicate aliases tests

* test: extend timeout

* test: split windows esm-cjs tests

* test: parallelize linux interop tests too

* test: typo

* test: use right executor

* test: use right executor for clean up

* chore: update eslint libs (#792)

* chore: update eslint libs

* chore: clean up

* chore: tests and linting

* test: windows paths

* fix: exports

* test: update run import

* chore: replaceAll

* fix: error exit codes

* fix: use es2021

* feat: use ES2022

* fix: use ES2021 again

* test: incorporate flags and args in esm-cjs tests

* test: use correct expected values

---------

Co-authored-by: Shane McLaughlin <[email protected]>

* chore(release): 3.0.0-beta.14 [skip ci]

* fix: allow undefined from flag parser

* chore(release): 3.0.0-beta.15 [skip ci]

* feat: set spinner style

* chore(release): 3.0.0-beta.16 [skip ci]

* test: unset config vars after setting them

* feat: remove ts-node (#794)

* feat: drop ts-node dependency

* test: use --json for config unset

* chore(release): 3.0.0-beta.17 [skip ci]

* fix: use ES2022 (#793)

* fix: use ES2022

* test: use --json for config unset

* feat: stop using getters and setters for flags

* chore: clean up

* feat: expose json flag

* feat: remove pass through getter and setter

* fix: correct order of flags in toCached

* chore: clean up

* fix: flag merge order

* chore: documentation

* test: use oclif/test v3

* feat: set spinner style on windows too

* fix: handle cmd with baseFlags but no flags

* fix: some circular deps

* fix: circular deps in help

* fix: ts-node and config circular deps

* fix: toCached circular dep in help

* chore: organize utils

* test: enforce no circular deps

* chore: remove Flags.json

* chore: add prettier config

* test: add nyc

* test: improve test coverage

* test: windows unit tests

* chore: revert change to automerge.yml

* chore: code review

* perf: parallelize cacheCommand

* chore(release): 3.0.0-beta.18 [skip ci]

* chore: use prettier and lint-staged (#798)

* chore: update prettier config

* chore: prettier and lint-staged

* chore: reformat everything

* chore: deal with reformat aftermath

* chore: update configs and deps

* perf: move ansi-escapes require to top level

* chore: automerge.yml

* chore: unpin eslint-plugin-prettier

* chore: remove prettier plugin

* chore: update lint-staged config

* fix: update util import

* chore(release): 3.0.0-beta.19 [skip ci]

* chore: remove util/index.ts (#802)

* fix: remove tsPath export

* fix: move @types/cli-progress to devDeps

* chore(release): 3.0.0-beta.20 [skip ci]

* fix: force release

* chore(release): 3.0.0-beta.21 [skip ci]

* fix: move styledJson to index

* chore(release): 3.0.0-beta.22 [skip ci]

* feat: collect perf results from outside oclif (#797)

* feat: collect perf results from outside oclif

* chore: pr feedback

* refactor: naming for non-core perf

* chore(release): 3.0.0-beta.23 [skip ci]

* fix: remove OCLIF_NEXT_VERSION

* chore: add prepare for husky install

* test: try false for ignoreScripts

* chore(release): 3.0.0-beta.25 [skip ci]

* test: ignore scripts for external nuts

* chore: use eslint-plugin-perfectionist (#807)

---------

Co-authored-by: svc-cli-bot <[email protected]>
Co-authored-by: Shane McLaughlin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants