@commercetools-docs/writing-style NPM

commercetools Writing Style Linter

This package provides

commercetools specific writing style and terminology rules for the configurable vale prose linter.
the commercetools-vale command line tool which wraps a bundled vale build and calls it using the included writing style and configuration

The base style is the Google Developer Documentation Style Guide, which is included as a copy (MIT licensed, too) and modified and enriched with commercetools specific rules.

The configuration defaults to checking .md, .mdx, .txt, and .html files, which can be overridden by calling it with a command-line parameter commercetools-vale --glob='*.{js,md}' ./path/to/content passing a list of supported file format extensions.

As of Nov 2019, basing off Google's styles was a pragmatic choice. Other styles like Microsoft's are attractive starting points, too.

Linter Usage: Standalone command-line

Install the command globally via yarn global add @commercetools-docs/writing-style or npm install -g @commercetools-docs/writing-style
Use it by calling commercetools-vale ./path/to/your/content

Please don't forget to frequently update the package to get the latest styles.

Linter Usage: In Editor plugins

In addition, you can install a matching editor plugin to get immediate feedback while authoring. If your plugin allows, reconfigure the command from vale to commercetools-vale.

The plugin for VSCode does not support such configuration yet.

Linter Usage: CI and command line in Javascript Projects

Add the writing-style package as a development dependency: yarn add --dev @commercetools-docs/writing-style
In your project's folder, call it from the command line via npx commercetools-vale ./your/path/to/content and optionally add vale command line parameters as needed (for example --no-wrap on command line jobs).
- Tip: Running it over your complete repository is not a good idea since it checks the complete node_modules folder which takes a long time and is not your content.

Contributing

All contributions, especially to enrich and complete the commercetools specific terminology and branding are welcome.

Please always provide content examples in the pull request to explain the rationale and typical use cases.

7zip-bin node-fetch shelljs

@everything-registry/sub-chunk-190 @infinitebrahmanuniverse/nolb-_comm

0.0.0-canary-20240502092329

6 days ago

3.3.9

28 days ago

0.0.0-canary-20240410092210

28 days ago

0.0.0-canary-20240409144733

29 days ago

0.0.0-canary-20240409114645

29 days ago

0.0.0-canary-20240409081114

29 days ago

3.3.8

4 months ago

0.0.0-canary-20240102115949

4 months ago

0.0.0-canary-20231227113356

4 months ago

0.0.0-canary-20231222132931

5 months ago

0.0.0-canary-20231221152453

5 months ago

0.0.0-canary-20231221155410

5 months ago

3.3.7

5 months ago

0.0.0-canary-20231214143044

5 months ago

0.0.0-canary-20231214091338

5 months ago

0.0.0-canary-20231214104840

5 months ago

0.0.0-canary-20231205140430

5 months ago

0.0.0-canary-20231128085116

5 months ago

0.0.0-canary-20231128155149

5 months ago

3.3.6

11 months ago

0.0.0-canary-20230608080641

11 months ago

0.0.0-canary-20230426121710

1 year ago

0.0.0-canary-20230425194644

1 year ago

0.0.0-canary-20230427123601

1 year ago

0.0.0-canary-20230427135847

1 year ago

0.0.0-canary-20230427110517

1 year ago

0.0.0-canary-20230426124111

1 year ago

0.0.0-canary-20230427100710

1 year ago

0.0.0-canary-20230426112109

1 year ago

0.0.0-canary-20230425150430

1 year ago

0.0.0-canary-20230427092620

1 year ago

3.3.5

1 year ago

0.0.0-canary-20230310094447

1 year ago

0.0.0-canary-20230321154057

1 year ago

0.0.0-canary-20230310081946

1 year ago

0.0.0-canary-20230320134448

1 year ago

0.0.0-canary-20230310085514

1 year ago

0.0.0-canary-20230321162923

1 year ago

0.0.0-canary-20230321115059

1 year ago

0.0.0-canary-20230321121604

1 year ago

0.0.0-canary-20230321124322

1 year ago

0.0.0-canary-20230321140333

1 year ago

0.0.0-canary-20230320210324

1 year ago

0.0.0-canary-20230317140943

1 year ago

0.0.0-canary-20230321133514

1 year ago

0.0.0-canary-20230320215654

1 year ago

0.0.0-canary-20230321130353

1 year ago

0.0.0-canary-20230310083713

1 year ago

0.0.0-canary-20230321091049

1 year ago

0.0.0-canary-20230321143223

1 year ago

0.0.0-canary-20230321183214

1 year ago

0.0.0-canary-20230321155548

1 year ago

0.0.0-canary-20230321095040

1 year ago

3.3.4

1 year ago

0.0.0-canary-20230320144344

1 year ago

3.3.3

1 year ago

0.0.0-canary-20221124140226

1 year ago

0.0.0-canary-20221124111011

1 year ago

0.0.0-canary-20221124155145

1 year ago

0.0.0-canary-20221017095012

2 years ago

0.0.0-canary-20221207205000

1 year ago

0.0.0-canary-20221128093819

1 year ago

0.0.0-canary-20221122150149

1 year ago

0.0.0-canary-20221121144753

1 year ago

0.0.0-canary-20221017102901

2 years ago

0.0.0-canary-20221202142856

1 year ago

0.0.0-canary-20221209133620

1 year ago

0.0.0-canary-20221202132148

1 year ago

0.0.0-canary-20221202095829

1 year ago

3.3.1

2 years ago

3.3.2

1 year ago

0.0.0-canary-20221014192746

2 years ago

0.0.0-canary-20221013202619

2 years ago

0.0.0-canary-20220915153851

2 years ago

0.0.0-canary-20220908071630

2 years ago

0.0.0-canary-20220912084258

2 years ago

0.0.0-canary-20220915120717

2 years ago

0.0.0-canary-20220906080201

2 years ago

3.3.0

2 years ago

0.0.0-canary-20220901102305

2 years ago

0.0.0-canary-20220614140329

2 years ago

0.0.0-canary-20220805131500

2 years ago

3.2.0

2 years ago

0.0.0-canary-20220615132650

2 years ago

0.0.0-canary-20220615111824

2 years ago

0.0.0-canary-20220614214810

2 years ago

3.1.1

2 years ago

0.0.0-canary-20220425123131

2 years ago

0.0.0-canary-20220406105634

2 years ago

0.0.0-canary-20220317122436

2 years ago

3.1.0

2 years ago

0.0.0-canary-20220310160712

2 years ago

0.0.0-canary-20220310211022

2 years ago

0.0.0-canary-20220311085341

2 years ago

0.0.0-canary-20220317115638

2 years ago

0.0.0-canary-20220412121925

2 years ago

3.0.12

2 years ago

0.0.0-canary-20220331145419

2 years ago

0.0.0-canary-20220406090831

2 years ago

0.0.0-canary-20220311085318

2 years ago

0.0.0-canary-20220408093132

2 years ago

0.0.0-canary-20220201155715

2 years ago

0.0.0-canary-20220111160551

2 years ago

0.0.0-canary-20220124160107

2 years ago

0.0.0-canary-20220203101511

2 years ago

0.0.0-canary-20220202075648

2 years ago

0.0.0-canary-20220121084617

2 years ago

0.0.0-canary-20220203093155

2 years ago

0.0.0-canary-20220121140510

2 years ago

3.0.9

2 years ago

0.0.0-canary-20220112080520

2 years ago

0.0.0-canary-20220111220131

2 years ago

0.0.0-canary-20220207124451

2 years ago

3.0.10

2 years ago

3.0.11

2 years ago

0.0.0-canary-20220124084639

2 years ago

0.0.0-canary-20220111174642

2 years ago

0.0.0-canary-20220201122758

2 years ago

0.0.0-canary-20220124111724

2 years ago

0.0.0-canary-20220207144026

2 years ago

0.0.0-canary-20220201192356

2 years ago

0.0.0-canary-20220111205113

2 years ago

0.0.0-canary-20211019161132

2 years ago

0.0.0-canary-202110178546

2 years ago

0.0.0-canary-20211023124435

2 years ago

0.0.0-canary-2021101622855

2 years ago

0.0.0-canary-2021102281639

2 years ago

0.0.0-canary-2021102212206

2 years ago

0.0.0-canary-2021101782533

2 years ago

0.0.0-canary-20211016212148

2 years ago

0.0.0-canary-20211022125626

2 years ago

0.0.0-canary-2021101710369

2 years ago

0.0.0-canary-20211022808

2 years ago

3.0.8

2 years ago

0.0.0-canary-2021102483330

2 years ago

0.0.0-canary-20211016203612

2 years ago

0.0.0-canary-2021102281555

2 years ago

0.0.0-canary-2021102293649

2 years ago

0.0.0-canary-2021102291625

2 years ago

0.0.0-canary-20211022203039

2 years ago

0.0.0-canary-20211017155442

2 years ago

0.0.0-canary-20211016222311

2 years ago

0.0.0-canary-20211025143554

2 years ago

0.0.0-canary-202182416530

3 years ago

3.0.7

3 years ago

0.0.0-canary-2021519318

3 years ago

3.0.6

3 years ago

0.0.0-canary-2021426141419

3 years ago

0.0.0-canary-2021426113751

3 years ago

0.0.0-canary-202142613356

3 years ago

0.0.0-canary-2021420152545

3 years ago

0.0.0-canary-202121712415

3 years ago

3.0.5

3 years ago

0.0.0-canary-202102817258

3 years ago

3.0.4

3 years ago

0.0.0-canary-202102814229

3 years ago

0.0.0-canary-2021013141341

3 years ago

0.0.0-canary-202101314326

3 years ago

0.0.0-canary-2021013111739

3 years ago

3.0.3

3 years ago

0.0.0-canary-2020824143930

4 years ago

0.0.0-canary-2020824163748

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

0.0.0-canary-2020824181922

4 years ago

0.0.0-canary-2020823114221

4 years ago

0.0.0-canary-202082395420

4 years ago

0.0.0-canary-202082212338

4 years ago

0.0.0-canary-2020822121211

4 years ago

0.0.0-canary-2020821124627

4 years ago

0.0.0-canary-271d76aaed534c95ca281f6ac7f0e2fc2a223551

4 years ago

0.0.0-canary-ca5d835da62191eb2343eb7bcfb57985f23eb186

4 years ago

0.0.0-canary-6b19dbc32d60954e0c741757045e1805b32cb001

4 years ago

0.0.0-canary-d38854b5a2740222da78d1e83a3c503b74b01a44

4 years ago

0.0.0-canary-ea2491d0cec6c96c6c55f18e1216f240c13e37c4

4 years ago

0.0.0-canary-8c1a43e61e1050db0fe4aa61cbcda3bf2d978a46

4 years ago

0.0.0-canary-08e13cd4bf505dbc6124077bc794a0777ffa88f3

4 years ago

0.0.0-canary-594bd2cc425130ca04acdfece5e4a87fa0f7370b

4 years ago

0.0.0-canary-4e690472d48135461ab3b1fa5b6fcdfc789e19a2

4 years ago

0.0.0-canary-b60dd297698c5ffa5aceb6419ff3334ecf54a24e

4 years ago

0.0.0-canary-e58e26a0399afc6a86a49721971a5999b2df25b7

4 years ago

0.0.0-canary-751e487ee267aaa5b1459c0d95e66370fab67c00

4 years ago

0.0.0-canary-3dd84ca932145271cc6dba0e79d5e129a4e5a090

4 years ago

0.0.0-canary-f9310aea0c1d97ccfd692fd2248cee3f2854302a

4 years ago

0.0.0-canary-2a10b577d4eff473461f4b9bc590c35eed3da45a

4 years ago

0.0.0-canary-2e3ef6b0e7bc587de3308c94381a38b0c70b86ca

4 years ago

0.0.0-canary-eb907dba538f8d63a41f3c123ddba74c9edc3f06

4 years ago

0.0.0-canary-e1f632630d7f2dcb172dd356c03a8838f9a2029e

4 years ago

0.0.0-canary-d022961958b6ce74c9fc51b9688bd8a662736cca

4 years ago

0.0.0-canary-7d5f863444acd8cceb521411b7eee07ea0daba2b

4 years ago

0.0.0-canary-0d962cfee89535eb8a5e91631f82f4b97dd6d1e6

4 years ago

0.0.0-canary-620677547ea378038309ac508872dd889383c4c8

4 years ago

0.0.0-canary-14727f3fd63d5416397ff732b52ee59196fd84e3

4 years ago

0.0.0-canary-0ff6264874a88555891bb838e5acec026a3cacaa

4 years ago

0.0.0-canary-2f1fe2e44d71d1a1e30e6f04cf4475767712f485

4 years ago

0.0.0-canary-a8ba1b24913a6857941d4fdd35733086b7e2560f

4 years ago

0.0.0-canary-1402e6cc2843d274dfc1374ca91ba0aaa69d499f

4 years ago

0.0.0-canary-7e4fc0eecd2d225e4355471bbf2f3a0589c45639

4 years ago

0.0.0-canary-c18f1fa7c31244912145fe4b8c8f5352fe1fd0ed

4 years ago

0.0.0-canary-8741c0503481a60ab852e8880e79a351cbbeb25a

4 years ago

0.0.0-canary-498f75c4d664a1c55c35dbe3ae0a86845e35bbf9

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago