diff --git a/CHANGELOG.md b/CHANGELOG.md index 642079a1..16e012ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -315,7 +315,7 @@ ### Features -* command install as an alias of command add ([b0a30f3](https://github.com/openupm/openupm-cli/commit/b0a30f3cdff6249712f532f376d5980354b9e94a)) +* command "install" as an alias of command add ([b0a30f3](https://github.com/openupm/openupm-cli/commit/b0a30f3cdff6249712f532f376d5980354b9e94a)) # [1.2.0](https://github.com/openupm/openupm-cli/compare/1.1.1...1.2.0) (2020-01-05) diff --git a/README.md b/README.md index 6ccca57a..2ba51963 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ![npm](https://img.shields.io/npm/v/openupm-cli) ![NPM](https://img.shields.io/npm/l/openupm-cli) ![npm](https://img.shields.io/npm/dm/openupm-cli) -The command-line tool to maintain the Unity manifest file for 3rd-party upm registries, offering a similar but lighter experience like *npm* or *yarn* for NodeJS. +The command-line tool to maintain the Unity manifest file for 3rd-party upm registries, offering a similar but lighter experience like *npm* or *yarn* for Node.js. The tool is designed to work with [the OpenUPM registry](https://openupm.com), but can also work with any upm registries, including the official Unity registry. @@ -75,7 +75,7 @@ internal/modules/cjs/loader.js:818 Error: Cannot find module 'node:net' ``` -Please install [nodejs 16 or above](https://nodejs.org/en/download/). +Please install [Node.js 16 or above](https://nodejs.org/en/download/). ## China region @@ -152,9 +152,9 @@ open deps --deep ### Authenticate with a scoped registry -Starting from Unity 2019.3.4f1, you can configure the`.upmconfig.toml` file to authenticate with a scoped registry. The `openupm login` command helps you authenticate with an npm server and store the info to the UPM config file. +Starting from Unity 2019.3.4f1, you can configure the`.upmconfig.toml` file to authenticate with a scoped registry. The `openupm login` command helps you authenticate with a npm server and store the info to the UPM config file. -There are two ways to authenticate with an npm server: +There are two ways to authenticate with a npm server: - using token (recommended): a server-generated string for the grant of access and publishing rights. - using basic authentication: the `username:password` pair (base64 encoded) is stored to authenticate with the server on each request. @@ -266,7 +266,7 @@ openupm --verbose ... ## Work with Unity official (upstream) registry -Most commands can fallback to Unity upstream registry if necessary, to make it easier to mix the official registry with a 3rd-party registry. i.e. +Most commands can fall back to Unity upstream registry if necessary, to make it easier to mix the official registry with a 3rd-party registry. i.e. ``` $ openupm add com.unity.addressables com.littlebigfun.addressable-importer diff --git a/src/utils/process.ts b/src/utils/process.ts index 20ad13b3..97929748 100644 --- a/src/utils/process.ts +++ b/src/utils/process.ts @@ -16,7 +16,7 @@ export default function execute( */ return new Promise(function (resolve, reject) { /** - * @param {Error} error An error triggered during the execution of the childProcess.exec command + * @param {Error} error An error triggered during the execution of the "childProcess.exec" command * @param {string|Buffer} stdout The result of the shell command execution * @param {string|Buffer} stderr The error resulting of the shell command execution * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback diff --git a/tsconfig.build.json b/tsconfig.build.json index f6ee3201..b4afcc02 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -42,7 +42,7 @@ // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ // "resolveJsonModule": false, /* Enable importing .json files. */ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ - // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + // "noResolve": true, /* Disallow 'imports, 'requires or 's from expanding the number of files TypeScript should add to a project. */ /* JavaScript Support */ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ diff --git a/tsconfig.json b/tsconfig.json index f7241611..3a094da3 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -43,7 +43,7 @@ // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ "resolveJsonModule": false, /* Enable importing .json files. */ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ - // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + // "noResolve": true, /* Disallow 'imports, 'requires or 's from expanding the number of files TypeScript should add to a project. */ /* JavaScript Support */ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */