Merge pull request #1281 from FoalTS/remove-run-alias

Remove the alias `foal run-script` of `foal run`.

docs/blog/version-5.0-release-notes.md

@@ -16,4 +16,5 @@ Version 5.0 of [Foal](https://foalts.org/) is out!
 
 ## Removal of depreacted components
 
-- The deprecated hook `@Log` has been removed. To replace it, you can use the `Logger` service in a custom `@Hook`.
+- The deprecated hook `@Log` has been removed. To replace it, you can use the `Logger` service in a custom `@Hook`.
+- The command alias `npx foal run-script` has been removed. Use `npx foal run` instead.

docs/docs/cli/shell-scripts.md

@@ -55,7 +55,7 @@ npm run build
 Then you can execute it with this command:
 
 ```shell
-npx foal run my-script # or npx foal run-script my-script
+npx foal run my-script
 ```
 
 > You can also provide additionnal arguments to your script (for example: `npx foal run my-script foo=1 bar='[ 3, 4 ]'`). The default template in the generated scripts shows you how to handle such behavior.

packages/cli/package.json

@@ -5,15 +5,15 @@
  "main": "./lib/index.js",
  "types": "./lib/index.d.ts",
  "scripts": {
- "test": "npm run test:generators && npm run test:run-script && npm run test:create-secret && npm run test:rmdir && npm run test:fs",
+ "test": "npm run test:generators && npm run test:run && npm run test:create-secret && npm run test:rmdir && npm run test:fs",
  "test:fs": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/generate/file-system.spec.ts\"",
  "dev:test:fs": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/generate/file-system.spec.ts\"",
  "test:generators": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/generate/generators/**/*.spec.ts\"",
  "dev:test:generators": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/generate/generators/**/*.spec.ts\"",
  "test:rmdir": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/rmdir/**/*.spec.ts\"",
  "dev:test:rmdir": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/rmdir/**/*.spec.ts\"",
- "test:run-script": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/run-script/**/*.spec.ts\"",
- "dev:test:run-script": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/run-script/**/*.spec.ts\"",
+ "test:run": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/run/**/*.spec.ts\"",
+ "dev:test:run": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/run/**/*.spec.ts\"",
  "test:create-secret": "mocha --file \"./src/test.ts\" --require ts-node/register \"./src/create-secret/**/*.spec.ts\"",
  "dev:test:create-secret": "mocha --file \"./src/test.ts\" --require ts-node/register --watch --extension ts \"./src/create-secret/**/*.spec.ts\"",
  "build": "rimraf lib && tsc -p tsconfig-build.json && copyfiles -a -u 3 \"src/generate/templates/**/*\" lib/generate/templates",

packages/cli/src/index.ts

@@ -26,7 +26,7 @@ import {
 } from './generate';
 import { ClientError } from './generate/file-system';
 import { rmdir } from './rmdir';
-import { runScript } from './run-script';
+import { runScript } from './run';
 
 function displayError(...lines: string[]): void {
  console.error();
@@ -67,7 +67,6 @@ program
 program
  .command('run')
  .argument('<name>', 'Name of the script to run')
- .alias('run-script')
  .description('Run a shell script.')
  .action((name: string) => {
  runScript({ name }, process.argv);

packages/cli/src/run-script/get-command-line-arguments.util.spec.ts → packages/cli/src/run/get-command-line-arguments.util.spec.ts

@@ -6,11 +6,11 @@ import { getCommandLineArguments } from './get-command-line-arguments.util';
 
 describe('getCommandLineArguments', () => {
  it('should convert the arguments to an object.', () => {
- // npx foal run-script foo foo=barfoo bar='hello world'
+ // npx foal run foo foo=barfoo bar='hello world'
  const argv = [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  'prod',
  'foo=barfoo',
@@ -28,7 +28,7 @@ describe('getCommandLineArguments', () => {
  const argv = [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  'bar={ "foo": "bar" }',
  'foo=3'

packages/cli/src/run-script/run-script.spec.ts → packages/cli/src/run/run-script.spec.ts

@@ -81,7 +81,7 @@ describe('runScript', () => {
  await runScript({ name: 'my-script' }, [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  'email=bar',
  'n=11'
@@ -111,7 +111,7 @@ describe('runScript', () => {
  await runScript({ name: 'my-script' }, [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  'foo=bar',
  ]);
@@ -146,7 +146,7 @@ describe('runScript', () => {
  await runScript({ name: 'my-script' }, [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  'foo=bar',
  ]);
@@ -178,7 +178,7 @@ describe('runScript', () => {
  await runScript({ name: 'my-script' }, [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  ], log);
 
@@ -201,7 +201,7 @@ describe('runScript', () => {
  await runScript({ name: 'my-script' }, [
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/node',
  '/Users/loicpoullain/.nvm/versions/node/v8.11.3/bin/foal',
- 'run-script',
+ 'run',
  'my-script',
  ], log);