@adinsure-ops/ops-cli 5.0.0-rc3 → 5.0.0-rc5

package/CHANGELOGS.md

@@ -1,20 +1,29 @@
 # Changelogs
 
-## 5.0.0-rc1
 
-- bugfixes
-- security patching: the project was migrated to a new oclif framework from the old one
-- performace tuning
-- removal of the prepare-content command
+## 5.0.0-rc5: 2023-09-08
+
+- Added --description flag to the log command
+
+## 5.0.0-rc4: 2023-09-05
+
+- Added --keep flag to the download:studio command
+
+## 5.0.0-rc3: 2023-09-01
+
+- Bugfixes
+- Security patching: the project was migrated to a new oclif framework from the old one
+- Performace tuning
+- [DEPRECATED] Deprecation and removal of the prepare-content command
 
 ## 4.8.3: 2023-08-22
 
-- bugfixes; sql command was fixed so that even when Extend was not used it required its parameters
-- security patches in library dependencies
+- Bugfixes; sql command was fixed so that even when Extend was not used it required its parameters
+- Security patches in library dependencies
 
 ## 4.8.2: 2023-07-28
 
-- sql command can now generate a template for mssql and oracle, for extending an sql table with a column
+- Sql command can now generate a template for mssql and oracle, for extending an sql table with a column
 
 ## 4.8.1: 2023-06-01
 
@@ -30,45 +39,45 @@
 
 ## 4.7.0: 2023-03-22
 
-- fixed bug in `download:studio` when flag `-i` was always required in case we used `-o` flag
-- download of signalr is now also supported
-- improved description for download topic, it now displays information on downloading individual components
-- update command is no longer supported. Instead the update available warning provides information on available update options
+- Fixed bug in `download:studio` when flag `-i` was always required in case we used `-o` flag
+- Download of signalr is now also supported
+- Improved description for download topic, it now displays information on downloading individual components
+- Update command is no longer supported. Instead the update available warning provides information on available update options
 
 ## 4.6.0: 2023-02-15
 
-- doctor no longer checks for `vsts-npm-auth` package
-- when installing studio you can pass parameter `s` to skip installation in case the selected version is already installed
+- Doctor no longer checks for `vsts-npm-auth` package
+- When installing studio you can pass parameter `s` to skip installation in case the selected version is already installed
 
 ## 4.5.2: 2023-01-12
 
-- limit description length for sql scripts
+- Limit description length for sql scripts
 
 ## 4.5.1: 2022-12-13
 
-- fixed release version for windows and linux packages
+- Fixed release version for windows and linux packages
 
 ## 4.5.0: 2022-10-05
 
-- add `--major` flag for sql script generation
-- add `SQL_SCRIPT_VERSION` to force script generation
+- Add `--major` flag for sql script generation
+- Add `SQL_SCRIPT_VERSION` to force script generation
 
 ## 4.4.0: 2022-10-03
 
-- added parameters for offline sql script creation
-- ability to recover from prerelease tag when creating db scripts
+- Added parameters for offline sql script creation
+- Ability to recover from prerelease tag when creating db scripts
 
 ## 4.3.0: 2022-07-27
 
-- added command `npm:dependency-update` to update dependencies on packages in workspace defined by filter
-- added command `nuget:dependency-update` to update dependencies on packages in workspace defined by filter
-- improve error handling in translation fetching
-- improve warning output when npm publish fails
+- Added command `npm:dependency-update` to update dependencies on packages in workspace defined by filter
+- Added command `nuget:dependency-update` to update dependencies on packages in workspace defined by filter
+- Improve error handling in translation fetching
+- Improve warning output when npm publish fails
 
 ## 4.2.0: 2022-07-15
 
-- added command `gitlab:get-tag-pipeline` to track pipeline status and wait for pipeline to finish
-- added `--outputVersionOnly` to `gitlab:next-nightly-tag` to output only version
+- Added command `gitlab:get-tag-pipeline` to track pipeline status and wait for pipeline to finish
+- Added `--outputVersionOnly` to `gitlab:next-nightly-tag` to output only version
 
 ## 4.1.0: 2022-06-15
 
@@ -76,55 +85,55 @@
 
 ## 4.0.0: 2021-05-31
 
-- new auth options
+- New auth options
 - [DEPRECATED] `--servicePrincipal` login is no longer available or required. 'AZURE_CLIENT_ID' and 'AZURE_CLIENT_SECRET' environment variables are required with every command in order to use service principal.
 
 ## 3.9.0: 2021-05-30
 
-- additional options for translations output filename
+- Additional options for translations output filename
 
 ## 3.8.1: 2021-05-17
 
-- fix GitLab next nightly tag when tags with `test` and `qa` annotation exists
+- Fix GitLab next nightly tag when tags with `test` and `qa` annotation exists
 
 ## 3.8.0: 2021-05-05
 
-- added GitLab next nightly tag
+- Added GitLab next nightly tag
 
 ## 3.7.0: 2021-04-28
 
-- added download commands for AdInsure Server, Client, IdentityServer and Scheduler
+- Added download commands for AdInsure Server, Client, IdentityServer and Scheduler
 
 ## 3.6.1: 2021-12-02
 
-- improve workspace search pattern for npm publish
+- Improve workspace search pattern for npm publish
 
 ## 3.6.0: 2021-11-30
 
-- add ability to transform files with prepare-content
+- Add ability to transform files with prepare-content
 
 ## 3.5.0: 2021-11-24
 
-- renaming prepare-content command
+- Renaming prepare-content command
 
 ## 3.4.0: 2021-10-24
 
-- added Jira command for listing labels and setting them
-- added Jira command for listing issue
+- Added Jira command for listing labels and setting them
+- Added Jira command for listing issue
 
 ## 3.3.1: 2021-10-16
 
-- exclude should be optional for npm:publish
+- Exclude should be optional for npm:publish
 
 ## 3.3.0: 2021-10-14
 
-- introduced npm check command
-- introcuced npm publish command
-- introduced doctor command
-- introduced download:platform and download:studio command
+- Introduced npm check command
+- Introcuced npm publish command
+- Introduced doctor command
+- Introduced download:platform and download:studio command
 
 ## 3.2.4: 2021-10-09
 
-- ignore VERSION file when using 'new' command
+- Ignore VERSION file when using 'new' command
 - Unexpected token in JSON files should not stop execution
-- introduce `--exclude-dir` parameter for `version` command
+- Introduce `--exclude-dir` parameter for `version` command

package/LICENSE

@@ -1 +1 @@
-(c) Copyright 2021 Adacta d.o.o., all rights reserved.
+(c) Copyright 2023 Adacta d.o.o., all rights reserved.

package/README.md

@@ -2,7 +2,7 @@
 
 Operations CLI for supporting AdInsure development processes.
 
-https://www.npmjs.com/package/@adinsure-ops/ops-cli
+<https://www.npmjs.com/package/@adinsure-ops/ops-cli>
 
 ## Install
 
@@ -10,7 +10,7 @@ https://www.npmjs.com/package/@adinsure-ops/ops-cli
 
 ## CLI development
 
-For development you will need **[Node.js](https://nodejs.org/en/)** (recommended 16 LTS, minimal 8.0.0) and **[Yarn](https://yarnpkg.com/en/)** installed. 
+For development you will need **[Node.js](https://nodejs.org/en/)** (recommended 16 LTS, minimal 14.0.0) and **[Yarn](https://yarnpkg.com/en/)** installed.
 
 We recommend **[Visual Studio Code](https://code.visualstudio.com/)** IDE.
 
@@ -26,30 +26,30 @@ You can run and debug commands directly from terminal by running `ops [command]`
 ## Commands
 
 <!-- commands -->
-- [`ops help [COMMAND]`](##ops-help-command)
-- [`ops doctor`](##ops-doctor)
-- [`ops download:client <flags>`](##ops-download:client-<flags>)
-- [`ops download:identity-server <flags>`](##ops-download:identity-server-<flags>)
-- [`ops download:platform <flags>`](##ops-download:platform-<flags>)
-- [`ops download:scheduler <flags>`](##ops-download:scheduler-<flags>)
-- [`ops download:server <flags>`](##ops-download:server-<flags>)
-- [`ops download:signalr <flags>`](##ops-download:signalr-<flags>)
-- [`ops download:studio <flags>`](##ops-download:studio-<flags>)
-- [`ops download:keycloak-scim <flags>`](##ops-download:keycloak-scim-<flags>)
-- [`ops download:jmeter-examples <flags>`](##ops-download:studio-<flags>) 
-- [`ops gitlab:get-tag-pipeline`](##ops-gitlab:get-tag-pipeline)
-- [`ops gitlab:next-nightly-tag`](##ops-gitlab:next-nightly-tag)
-- [`ops log <component> <issue> [options]`](##ops-log-<component>-<issue>-[options])
-- [`ops log:gen [options]`](##ops-log:gen-[options])
-- [`ops log:validate [options]`](##ops-log:validate-[options])
-- [`ops login`](##ops-login)
-- [`ops npm:check-publish`](##ops-npm:check-publish)
-- [`ops npm:publish`](##ops-npm:publish)
-- [`ops npm:dependency-update`](##ops-npm:dependency-update)
-- [`ops nuget:dependency-update`](##ops-nuget:dependency-update)
-- [`ops sql <type> <module> [flags]`](##ops-sql-<type>-<module>-[flags])
-- [`ops translate`](##ops-translate)
-- [`ops version <type> [flags]`](##ops-version-<type>[flags])
+- [`ops help [COMMAND]`](#ops-help-command)
+- [`ops doctor`](#ops-doctor)
+- [`ops download:client <flags>`](#ops-downloadclient-flags)
+- [`ops download:identity-server <flags>`](#ops-downloadidentity-server-flags)
+- [`ops download:platform <flags>`](#ops-downloadplatform-flags)
+- [`ops download:scheduler <flags>`](#ops-downloadscheduler-flags)
+- [`ops download:server <flags>`](#ops-downloadserver-flags)
+- [`ops download:signalr <flags>`](#ops-downloadsignalr-flags)
+- [`ops download:studio <flags>`](#ops-downloadstudio-flags)
+- [`ops download:keycloak-scim <flags>`](#ops-downloadkeycloak-scim-flags)
+- [`ops download:jmeter-examples <flags>`](#ops-downloadstudio-flags)
+- [`ops gitlab:get-tag-pipeline`](#ops-gitlabget-tag-pipeline)
+- [`ops gitlab:next-nightly-tag`](#ops-gitlabnext-nightly-tag)
+- [`ops log <issue> -t <type> -c [component]`](#ops-log-issue-t-type-c-component)
+- [`ops log:gen [options]`](#ops-loggen-options)
+- [`ops log:validate [options]`](#ops-logvalidate-options)
+- [`ops login`](#ops-login)
+- [`ops npm:check-publish`](#ops-npmcheck-publish)
+- [`ops npm:publish`](#ops-npmpublish)
+- [`ops npm:dependency-update`](#ops-npmdependency-update)
+- [`ops nuget:dependency-update`](#ops-nugetdependency-update)
+- [`ops sql <type> <module> [flags]`](#ops-sql-type-module-flags)
+- [`ops translate`](#ops-translate)
+- [`ops version <type> [flags]`](#ops-version-type)
 
 ## `ops help [COMMAND]`
 
@@ -66,7 +66,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src\commands\help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_
 
 ## `ops doctor`
 
@@ -191,6 +191,7 @@ USAGE
   $ ops download:studio <flags>
 
 OPTIONS
+  -k, --keep             only with install. If passed, it will not remove the vsix file
   -i, --install          install plugin to vscode. save to temp folder and remove vsix after.
   -o, --output=output    [default: ./] output directory
   -s, --skip             only with install. If passed, and desired version is installed it will skip it.
@@ -332,6 +333,7 @@ ARGUMENTS
 OPTIONS
   -c, --component=component                  Component for which new changelog should be generated
   -t, --type=feature|fixed|improve|breaking  (required) type of changelog
+  -d, --description=description              Description of a changelog
 
 ALIASES
   $ ops log
@@ -341,6 +343,7 @@ EXAMPLES
   $ ops log LJADIRD-1234 -t feature
   $ ops log LJADIRD-5678 -t fixed
   $ ops log LJADIRD-8765 -t breaking -c Platform
+  $ ops log LJADIRD-5678 -t fixed -d "Fixed my bug"
   $ ops log LJADIRD-4321 -t improve -c Configuration
 ```
 
@@ -530,15 +533,15 @@ EXAMPLES
 - _new-version_ allows setting own version regardles of VERSION file. **Incrementing NPM version separately is not supported in this case. NPM packages are also bumped to specified version.**
 
 > Prerelease Note: Prerelease should only be user in **master** branch.
-
+\\
 > Patch Note: Patch is used on **release/x.x** branches for creating patch releases
 > When creating new **release/x.x** branch 2 steps are needed:
 >
 > - creating _patch_ version on **release/x.x** branch
 > - creating _preminor_ or _premajor_ version on **master** branch
-
+\\
 > Dependencies for packages are updated on all package.json files. If prerelease version in specified full version is specified (example: 4.0.0-201911.0), or if non prerelease version ends with x (example: 3.5.x)
-
+\\
 > NPM packages node: For npm package to update properly _wsrun-version_ preset needs to be in _scripts_ portion of _package.json_. (example: `"wsrun-version": "yarn wsrun -p @adinsure-tools/* -p @adinsure/* -c"`)
 
 ## `ops sql <type> <module> [flags]`
@@ -560,7 +563,7 @@ OPTIONS
   -o, --offline                  generate database script with timestamp
   -v, --version=version          version for which you're generating database script
 
-// when using the Extend datascript type to add a new column (column-name, column-type) to the table (table-name in table-schema) 
+Extend type options for extending DBs:
   --table-schema                 table schema name
   --table-name                   table name
   --column-name                  new column's name 

package/lib/commands/download/studio.d.ts

@@ -9,6 +9,7 @@ export default class DownloadStudio extends CommandBase<typeof DownloadStudio> {
         output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         install: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         skip: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        keep: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     private readonly url;
     /**

package/lib/commands/download/studio.js

@@ -56,8 +56,15 @@ class DownloadStudio extends CommandBase {
                 this.log(`The ${studioVersion} already exists. Skipping install.`);
                 return 0;
             }
-            ux.action.start(`Downloading AdInsure Studio version ${flags.version} to ${filePath}`, undefined, { stdout: true });
             try {
+                const alreadyDownloaded = yield fs.pathExists(filePath);
+                if (alreadyDownloaded && flags.install) {
+                    ux.action.start(`Installing already downloaded AdInsure Studio version ${flags.version} from ${filePath}`, undefined, { stdout: true });
+                    yield this.installExtension(filePath);
+                    ux.action.stop(`${chalk.green('Done')}`);
+                    return;
+                }
+                ux.action.start(`Downloading AdInsure Studio version ${flags.version} to ${filePath}`, undefined, { stdout: true });
                 const file = yield this.downloadFile(flags.version);
                 const writeStream = fs.createWriteStream(filePath);
                 writeStream.write(file.data, 'binary');
@@ -67,8 +74,10 @@ class DownloadStudio extends CommandBase {
                         ux.action.start(`Installing into VSCode`, undefined, { stdout: true });
                         yield this.installExtension(filePath);
                         ux.action.stop(`${chalk.green('Done')}`);
-                        ux.action.start(`Removing VSIX file`, undefined, { stdout: true });
-                        fs.removeSync(filePath);
+                        if (!flags.keep) {
+                            ux.action.start(`Removing VSIX file`, undefined, { stdout: true });
+                            fs.removeSync(filePath);
+                        }
                         ux.action.stop(`${chalk.green('Done')}`);
                         this.log(`${chalk.yellow('Use \'CRTL + SHIFT + P\' and select reload windows to apply this studio version.')}`);
                     }
@@ -100,6 +109,7 @@ DownloadStudio.examples = [
     `$ ops download:studio -v 15.0.0 -o ~/Downloads`,
     `$ ops download:studio -v 15.0.0 -i`,
     `$ ops download:studio -v 15.0.0 -i -s`,
+    `$ ops download:studio -v 15.0.0 -i -k`,
 ];
 DownloadStudio.flags = {
     version: Flags.string({
@@ -122,5 +132,10 @@ DownloadStudio.flags = {
         description: 'only with install. If passed, and desired version is installed it will skip it.',
         dependsOn: ['install'],
     }),
+    keep: Flags.boolean({
+        char: 'k',
+        description: 'only with install. If passed, it will not remove the vsix file.',
+        dependsOn: ['install'],
+    }),
 };
 export default DownloadStudio;

package/lib/commands/log/add.d.ts

@@ -10,6 +10,7 @@ export default class Changelog extends CommandBase<typeof Changelog> {
     static flags: {
         type: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         component: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        description: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/lib/commands/log/add.js

@@ -54,7 +54,7 @@ class Changelog extends CommandBase {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const responses = yield inquirer.prompt([{
                         name: 'component',
-                        message: 'Multiple components found. Select a changelog componet',
+                        message: 'Multiple components found. Select a changelog component',
                         type: 'list',
                         choices: possibleComponents,
                     }]);
@@ -75,7 +75,7 @@ class Changelog extends CommandBase {
                     issue: changelogIssue,
                     type: changelogType,
                 },
-                content: 'Explain your changes here',
+                content: flags.description || 'Explain your changes here',
             };
             yield fs.writeFile(changelogPath, matter.stringify(entry.content, entry.meta));
             this.log(`Created changelog for ${changelogIssue} in '${changelogPath}'`);
@@ -108,5 +108,10 @@ Changelog.flags = {
         description: 'Component for which new changelog should be generated',
         default: '',
     }),
+    description: Flags.string({
+        char: 'd',
+        description: 'Description of a changelog',
+        default: '',
+    }),
 };
 export default Changelog;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.0.0-rc3",
+  "version": "5.0.0-rc5",
   "commands": {
     "doctor": {
       "id": "doctor",
@@ -634,7 +634,8 @@
       "examples": [
         "$ ops download:studio -v 15.0.0 -o ~/Downloads",
         "$ ops download:studio -v 15.0.0 -i",
-        "$ ops download:studio -v 15.0.0 -i -s"
+        "$ ops download:studio -v 15.0.0 -i -s",
+        "$ ops download:studio -v 15.0.0 -i -k"
       ],
       "flags": {
         "version": {
@@ -669,6 +670,16 @@
           "dependsOn": [
             "install"
           ]
+        },
+        "keep": {
+          "name": "keep",
+          "type": "boolean",
+          "char": "k",
+          "description": "only with install. If passed, it will not remove the vsix file.",
+          "allowNo": false,
+          "dependsOn": [
+            "install"
+          ]
         }
       },
       "args": {}
@@ -941,6 +952,14 @@
           "description": "Component for which new changelog should be generated",
           "multiple": false,
           "default": ""
+        },
+        "description": {
+          "name": "description",
+          "type": "option",
+          "char": "d",
+          "description": "Description of a changelog",
+          "multiple": false,
+          "default": ""
         }
       },
       "args": {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@adinsure-ops/ops-cli",
     "description": "Operations CLI for working with AdInsure",
-    "version": "5.0.0-rc3",
+    "version": "5.0.0-rc5",
     "author": "Adacta Digital Service Department",
     "bin": {
         "ops": "./bin/run.js"