Skip to content

Commit

Permalink
refactor: adjust command descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
xDivisionByZerox committed Sep 4, 2023
1 parent 2389019 commit 193f14a
Show file tree
Hide file tree
Showing 155 changed files with 156 additions and 208 deletions.
2 changes: 1 addition & 1 deletion src/commands/airline/aircraftType.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

Check failure on line 2 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / TS-Check Tests: node-18, ubuntu-latest

Cannot find module '@faker-js/faker' or its corresponding type declarations.

const command = new Command('aircraftType')

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe assignment of an `any` value

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe member access .action on an `any` value

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe call of an `any` typed value

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe member access .description on an `any` value

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe call of an `any` typed value

Check failure on line 4 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe construction of an any type value
.description(`Returns a random aircraft type.`)
.description(`Generates a random aircraft type.`)
.action(() => {
console.log(faker.airline.aircraftType());

Check failure on line 7 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe member access .airline on an `any` value

Check failure on line 7 in src/commands/airline/aircraftType.ts

View workflow job for this annotation

GitHub Actions / Lint: node-18, ubuntu-latest

Unsafe call of an `any` typed value
});
Expand Down
4 changes: 1 addition & 3 deletions src/commands/airline/flightNumber.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

Check failure on line 2 in src/commands/airline/flightNumber.ts

View workflow job for this annotation

GitHub Actions / TS-Check Tests: node-18, ubuntu-latest

Cannot find module '@faker-js/faker' or its corresponding type declarations.

const command = new Command('flightNumber')
.description(
`Returns a random flight number. Flight numbers are always 1 to 4 digits long. Sometimes they are`,
)
.description(`Generates a random flight number.`)
.action(() => {
console.log(faker.airline.flightNumber());
});
Expand Down
4 changes: 1 addition & 3 deletions src/commands/airline/recordLocator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('recordLocator')
.description(
`Generates a random [record locator](https://en.wikipedia.org/wiki/Record_locator). Record locators`,
)
.description(`Generates a random record locator.`)
.action(() => {
console.log(faker.airline.recordLocator());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/bear.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('bear')
.description(`Returns a random bear species.`)
.description(`Generates a random bear species.`)
.action(() => {
console.log(faker.animal.bear());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/bird.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('bird')
.description(`Returns a random bird species.`)
.description(`Generates a random bird species.`)
.action(() => {
console.log(faker.animal.bird());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/cat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cat')
.description(`Returns a random cat breed.`)
.description(`Generates a random cat breed.`)
.action(() => {
console.log(faker.animal.cat());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/cetacean.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cetacean')
.description(`Returns a random cetacean species.`)
.description(`Generates a random cetacean species.`)
.action(() => {
console.log(faker.animal.cetacean());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/cow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cow')
.description(`Returns a random cow species.`)
.description(`Generates a random cow species.`)
.action(() => {
console.log(faker.animal.cow());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/crocodilia.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('crocodilia')
.description(`Returns a random crocodilian species.`)
.description(`Generates a random crocodilian species.`)
.action(() => {
console.log(faker.animal.crocodilia());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/dog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('dog')
.description(`Returns a random dog breed.`)
.description(`Generates a random dog breed.`)
.action(() => {
console.log(faker.animal.dog());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/fish.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('fish')
.description(`Returns a random fish species.`)
.description(`Generates a random fish species.`)
.action(() => {
console.log(faker.animal.fish());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/horse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('horse')
.description(`Returns a random horse breed.`)
.description(`Generates a random horse breed.`)
.action(() => {
console.log(faker.animal.horse());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/insect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('insect')
.description(`Returns a random insect species.`)
.description(`Generates a random insect species.`)
.action(() => {
console.log(faker.animal.insect());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/lion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('lion')
.description(`Returns a random lion species.`)
.description(`Generates a random lion species.`)
.action(() => {
console.log(faker.animal.lion());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/rabbit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('rabbit')
.description(`Returns a random rabbit species.`)
.description(`Generates a random rabbit species.`)
.action(() => {
console.log(faker.animal.rabbit());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/rodent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('rodent')
.description(`Returns a random rodent breed.`)
.description(`Generates a random rodent breed.`)
.action(() => {
console.log(faker.animal.rodent());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/snake.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('snake')
.description(`Returns a random snake species.`)
.description(`Generates a random snake species.`)
.action(() => {
console.log(faker.animal.snake());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/animal/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('type')
.description(`Returns a random animal type.`)
.description(`Generates a random animal type.`)
.action(() => {
console.log(faker.animal.type());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/cmyk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cmyk')
.description(`Returns a CMYK color.`)
.description(`Generates a CMYK color.`)
.action(() => {
console.log(faker.color.cmyk());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/colorByCSSColorSpace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('colorByCSSColorSpace')
.description(`Returns a random color based on CSS color space specified.`)
.description(`Generates a random color based on CSS color space specified.`)
.action(() => {
console.log(faker.color.colorByCSSColorSpace());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/cssSupportedFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cssSupportedFunction')
.description(`Returns a random css supported color function name.`)
.description(`Generates a random css supported color function name.`)
.action(() => {
console.log(faker.color.cssSupportedFunction());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/cssSupportedSpace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('cssSupportedSpace')
.description(`Returns a random css supported color space name.`)
.description(`Generates a random css supported color space name.`)
.action(() => {
console.log(faker.color.cssSupportedSpace());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/hsl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('hsl')
.description(`Returns an HSL color.`)
.description(`Generates an HSL color.`)
.action(() => {
console.log(faker.color.hsl());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/human.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('human')
.description(`Returns a random human readable color name.`)
.description(`Generates a random human readable color name.`)
.action(() => {
console.log(faker.color.human());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/hwb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('hwb')
.description(`Returns an HWB color.`)
.description(`Generates an HWB color.`)
.action(() => {
console.log(faker.color.hwb());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/lab.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('lab')
.description(`Returns a LAB (CIELAB) color.`)
.description(`Generates a LAB (CIELAB) color.`)
.action(() => {
console.log(faker.color.lab());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/lch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('lch')
.description(`Returns an LCH color. Even though upper bound of`)
.description(`Generates an LCH color. Even though upper bound of`)
.action(() => {
console.log(faker.color.lch());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/rgb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('rgb')
.description(`Returns an RGB color.`)
.description(`Generates an RGB color.`)
.action(() => {
console.log(faker.color.rgb());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/color/space.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('space')
.description(
`Returns a random color space name from the worldwide accepted color spaces.`,
`Generates a random color space name from the worldwide accepted color spaces.`,
)
.action(() => {
console.log(faker.color.space());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/department.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('department')
.description(`Returns a department inside a shop.`)
.description(`Generates a department inside a shop.`)
.action(() => {
console.log(faker.commerce.department());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/price.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('price')
.description(`Generates a price between min and max (inclusive).`)
.description(`Generates a price.`)
.action(() => {
console.log(faker.commerce.price());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/product.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('product')
.description(`Returns a short product name.`)
.description(`Generates a short product name.`)
.action(() => {
console.log(faker.commerce.product());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/productAdjective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('productAdjective')
.description(`Returns an adjective describing a product.`)
.description(`Generates an adjective describing a product.`)
.action(() => {
console.log(faker.commerce.productAdjective());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/productDescription.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('productDescription')
.description(`Returns a product description.`)
.description(`Generates a product description.`)
.action(() => {
console.log(faker.commerce.productDescription());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/commerce/productMaterial.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('productMaterial')
.description(`Returns a material of a product.`)
.description(`Generates a material of a product.`)
.action(() => {
console.log(faker.commerce.productMaterial());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/bsAdjective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('bsAdjective')
.description(`Returns a random company bs adjective.`)
.description(`Generates a random company bs adjective.`)
.action(() => {
console.log(faker.company.bsAdjective());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/bsBuzz.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('bsBuzz')
.description(`Returns a random company bs buzz word.`)
.description(`Generates a random company bs buzz word.`)
.action(() => {
console.log(faker.company.bsBuzz());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/bsNoun.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Command } from 'commander';
import { faker } from '@faker-js/faker';

const command = new Command('bsNoun')
.description(`Returns a random company bs noun.`)
.description(`Generates a random company bs noun.`)
.action(() => {
console.log(faker.company.bsNoun());
});
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/buzzAdjective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('buzzAdjective')
.description(
`Returns a random buzz adjective that can be used to demonstrate data being viewed by a manager.`,
`Generates a random buzz adjective that can be used to demonstrate data being viewed by a manager.`,
)
.action(() => {
console.log(faker.company.buzzAdjective());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/buzzNoun.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('buzzNoun')
.description(
`Returns a random buzz noun that can be used to demonstrate data being viewed by a manager.`,
`Generates a random buzz noun that can be used to demonstrate data being viewed by a manager.`,
)
.action(() => {
console.log(faker.company.buzzNoun());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/buzzVerb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('buzzVerb')
.description(
`Returns a random buzz verb that can be used to demonstrate data being viewed by a manager.`,
`Generates a random buzz verb that can be used to demonstrate data being viewed by a manager.`,
)
.action(() => {
console.log(faker.company.buzzVerb());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/catchPhraseAdjective.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('catchPhraseAdjective')
.description(
`Returns a random catch phrase adjective that can be displayed to an end user..`,
`Generates a random catch phrase adjective that can be displayed to an end user.`,
)
.action(() => {
console.log(faker.company.catchPhraseAdjective());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/catchPhraseDescriptor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('catchPhraseDescriptor')
.description(
`Returns a random catch phrase descriptor that can be displayed to an end user..`,
`Generates a random catch phrase descriptor that can be displayed to an end user.`,
)
.action(() => {
console.log(faker.company.catchPhraseDescriptor());
Expand Down
2 changes: 1 addition & 1 deletion src/commands/company/catchPhraseNoun.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { faker } from '@faker-js/faker';

const command = new Command('catchPhraseNoun')
.description(
`Returns a random catch phrase noun that can be displayed to an end user..`,
`Generates a random catch phrase noun that can be displayed to an end user.`,
)
.action(() => {
console.log(faker.company.catchPhraseNoun());
Expand Down
Loading

0 comments on commit 193f14a

Please sign in to comment.