docs(putout) style: spelling errors (#101)

Hans5958 · web-flow · commit 6048509eebe6 · 2022-05-09T13:41:47.000+03:00
diff --git a/README.md b/README.md
@@ -127,7 +127,7 @@ Usage: putout [options] [path]
 Options:
    -h, --help                  display this help and exit
    -v, --version               output version information and exit
-   -f, --format [formatter]    use a specific output format, the default is: 'progress-bar' localy and 'dump' on CI
+   -f, --format [formatter]    use a specific output format, the default is: 'progress-bar' locally and 'dump' on CI
    -s, --staged                add staged files when in git repository
    --fix                       apply fixes of errors to code
    --fix-count [count = 10]    count of fixes rounds
@@ -241,7 +241,7 @@ async function promise() {
 
 But for some reason you don't want so many changes.
 
-☝️ *Remember, **safe** mode of **[eslint-plugin-putout](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#safe-mode)** has the most dengerous rules **disabled**, so it can be used as **auto fix** on each **save** in your **IDE***.
+☝️ *Remember, **safe** mode of **[eslint-plugin-putout](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#safe-mode)** has the most dangerous rules **disabled**, so it can be used as **auto fix** on each **save** in your **IDE***.
 
 So, if you want to convert it to [`ESM`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) keeping everything else untouched  use **Ruler**: it can easily disable all rules 🐊**Putout** finds.
 
@@ -311,7 +311,7 @@ putout src --disable-all && putout src --enable convert-commonjs-to-esm && putou
 
 This command will **disable all rules** that 🐊**Putout** can find right now and **enable** a single rule. All built-in rules made for good and highly suggested to be used, all of them are enabled in all my repositories, since they have auto fix.
 
-☝️*You can always disable what you don't need, so give it a try you wan't regret 🐊.*
+☝️*You can always disable what you don't need, so give it a try. You won't regret 🐊.*
 
 Happy coding 🎈!
 
@@ -502,7 +502,7 @@ As you see, `places` is empty, but the code is changed: there is no `hi` variabl
 
 From the beginning, 🐊**Putout** developed with ability to split the main process into two concepts: `find` (find places that could be fixed) and `fix` (apply the fixes to the files).
 It is therefore easy to find sections that could be fixed.
-In the following example reduntand variables are found without making changes to the source file:
+In the following example redundant variables are found without making changes to the source file:
 
 ```js
 putout(source, {
@@ -1921,7 +1921,7 @@ Here is list of options:
 - `filesCount` - count of files with errors
 - `errorsCount` count of errors
 
-You can avoid any of this and use only what you nead. To make your formatter usable with `putout`, add the prefix `putout-formatter-` to your `npm` package,
+You can avoid any of this and use only what you need. To make your formatter usable with `putout`, add the prefix `putout-formatter-` to your `npm` package,
 and add the tags `putout`, `formatter`, `putout-formatter`.
 
 ### ESLint Formatters
@@ -2051,7 +2051,7 @@ Let's dive into plugin types that you can use for you next code transformation.
 
 ### Replacer
 
-The simplest 🐊**Putout** plugin type, consits of 2 functions:
+The simplest 🐊**Putout** plugin type consists of 2 functions:
 
 - `report` - report error message to `putout` cli;
 - `replace` - replace `key` template into `value` template;
@@ -2170,7 +2170,7 @@ Where `__` is a placeholder for anything.
 
 *☝️Remember: template key should be valid **JavaScript**, or **Node Type**, like in previous example.*
 
-You can also use `include` and/or `exclude` insead of `traverse` and `filter` ([more sophisticated example](https://github.com/coderaiser/putout/blob/v25.4.1/packages/plugin-add-return-await/lib/add-return-await.js)):
+You can also use `include` and/or `exclude` instead of `traverse` and `filter` ([more sophisticated example](https://github.com/coderaiser/putout/blob/v25.4.1/packages/plugin-add-return-await/lib/add-return-await.js)):
 
 ```js
 // should be always used include/or exclude, when traverse not used
@@ -2214,7 +2214,7 @@ test('remove debugger: report', (t) => {
     t.end();
 });
 
-// stetement should be removed so result is empty
+// statement should be removed so result is empty
 test('remove debugger: transformCode', (t) => {
     t.transformCode('debugger', '');
     t.end();
@@ -2226,7 +2226,7 @@ To see a more sophisticated example look at [@putout/plugin-remove-console](http
 
 ### 🤷‍♂️ What if I don't want to publish a plugin?
 
-If you don't want to publish a **plugin** you developed, you can pass it to 🐊**Putout** as an `object` described earler. Here is [how it can look like](https://github.com/coderaiser/mock-import/blob/v1.0.8/lib/convert-imports/index.js#L19-L33):
+If you don't want to publish a **plugin** you developed, you can pass it to 🐊**Putout** as an `object` described earlier. Here is [how it can look like](https://github.com/coderaiser/mock-import/blob/v1.0.8/lib/convert-imports/index.js#L19-L33):
 
 ```js
 putout('const a = 5', {
diff --git a/packages/engine-parser/README.md b/packages/engine-parser/README.md
@@ -19,7 +19,7 @@ npm i @putout/engine-parser
 - [esprima](https://esprima.org/)
 - [tenko](https://github.com/pvdz/tenko)
 
-Any parser should be installed before use, but you can be shure that `@babel/parse` always installed.
+Any parser should be installed before use, but you can be sure that `@babel/parse` always installed.
 
 ## API
 
@@ -50,7 +50,7 @@ You have two ways to benefit from source map generation:
 - using `Recast` print;
 - using `Babel` generator;
 
-#### Generate sourcemaps usign Recast
+#### Generate sourcemaps using Recast
 
 ```js
 const source = `const hello = 'world';`;
@@ -63,9 +63,9 @@ print(ast, {sourceMapName: 'hello.map'});
 {"version":3,"sources":["hello.js"],"names":[],"mappings":"AAAA...","file":"hello.map","sourcesContent":["const hello = 'world';"]}`;
 ```
 
-#### Generate sourcemaps usign Bebel
+#### Generate sourcemaps using Babel
 
-To generate sourcemap usig babel generator, you should use babel parser before.
+To generate sourcemap using babel generator, you should use babel parser before.
 This is low level transformation, because `Babel` doesn't preserve any formatting.
 
 ```js
diff --git a/packages/engine-processor/README.md b/packages/engine-processor/README.md
@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-loader.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/engine-loader"npm"
 
-🐊[**Putout**](https://github.com/coderaiser/putout) processor that runns all engines according to supported file types.
+🐊[**Putout**](https://github.com/coderaiser/putout) processor that runs all engines according to supported file types.
 
 ```
 npm i @putout/engine-processor
@@ -38,7 +38,7 @@ runProcessors({
 
 ## Processor Example
 
-Simplest possible procesor example can look like this:
+Simplest possible processor example can look like this:
 
 ```js
 module.exports.files = [
diff --git a/packages/engine-processor/test/processor.js b/packages/engine-processor/test/processor.js
@@ -228,15 +228,15 @@ test('putout: engine-processor: markdown: no fix: return processed places', asyn
 //
 // In this case we can benefit from:
 // - simplifiyng format of remark rules (which are splited on fix/report with help of options(!));
-// - spliting one big rule on a couple small rules;
+// - splitting one big rule on a couple small rules;
 //
 // Otherwise it will mutate the tree and report all found errors, so only one big rule with
 // "filter" + "fix" joined and one message is supported ☝️.
 //
 // Which is hard to maintain.
 // So we should choose between "robotic" format 🤖 and change file with no errors found but
 // easy to maintain plugins similar to ones 🐊**Putout** has.
-// Or hard to maitain one big blob of processing with one message but change only on --fix.
+// Or hard to maintain one big blob of processing with one message but change only on --fix.
 test('putout: engine-processor: markdown: no places no fix', async (t) => {
     const name = join(__dirname, 'fixture', 'no-places-no-change.md');
     const options = {
diff --git a/packages/operator-add-args/package.json b/packages/operator-add-args/package.json
@@ -3,7 +3,7 @@
   "version": "3.0.1",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
-  "description": "🐊Putout operator adds ability to add args to referenced variables that wan not defined",
+  "description": "🐊Putout operator adds ability to add args to referenced variables that was not defined",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/operator-add-args#readme",
   "main": "lib/add-args.js",
   "release": false,
diff --git a/packages/operator-declare/README.md b/packages/operator-declare/README.md
@@ -39,7 +39,7 @@ const {
 module.exports = declare({
     fs: {
         esm: `import fs from 'fs/promises'`,
-        comomnjs: `const fs = require('fs')`, // drop when not neaded
+        comomnjs: `const fs = require('fs')`, // drop when not needed
     },
 });
 ```
diff --git a/packages/operator-regexp/README.md b/packages/operator-regexp/README.md
@@ -4,7 +4,7 @@
 [NPMURL]: https://npmjs.org/package/@putout/operator-regexp "npm"
 
 🐊[**Putout**](https://github.com/coderaiser/putout) operator adds ability to determine that provided [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) can be
-converted to [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) without loosing it's sense.
+converted to [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) without losing it's sense.
 
 It is used for example in [regexp/convert-replace-to-relace-all](https://github.com/coderaiser/putout/tree/master/packages/plugin-regexp#regexpconvert-replace-to-replace-all):
 
diff --git a/packages/operator-regexp/package.json b/packages/operator-regexp/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
-  "description": "🐊Putout operator adds ability to check if provided regexp can be converted to string without loosing it's sense",
+  "description": "🐊Putout operator adds ability to check if provided regexp can be converted to string without losing it's sense",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/operator-regexp#readme",
   "main": "lib/regexp.js",
   "release": false,
diff --git a/packages/plugin-convert-commonjs-to-esm/README.md b/packages/plugin-convert-commonjs-to-esm/README.md
@@ -9,7 +9,7 @@
 >
 > (c) [parceljs](https://parceljs.org/languages/javascript/)
 
-🐊[**Putout**](https://github.com/coderaiser/putout) plugin adds ability to convert Commonjs to ESM.
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin adds ability to convert CommonJS to ESM.
 
 ## Install
 
diff --git a/packages/plugin-convert-commonjs-to-esm/lib/exports/index.js b/packages/plugin-convert-commonjs-to-esm/lib/exports/index.js
@@ -12,7 +12,7 @@ const {
     ExportNamedDeclaration,
 } = types;
 
-module.exports.report = () => 'ESM should be used insted of Commonjs';
+module.exports.report = () => 'ESM should be used instead of CommonJS';
 
 module.exports.exclude = () => [
     '__, __',
diff --git a/packages/plugin-convert-commonjs-to-esm/lib/exports/index.spec.js b/packages/plugin-convert-commonjs-to-esm/lib/exports/index.spec.js
@@ -7,7 +7,7 @@ const test = createTest(__dirname, {
 });
 
 test('plugin-convert-commonjs-to-esm: exports: transform: report', (t) => {
-    t.report('exports', 'ESM should be used insted of Commonjs');
+    t.report('exports', 'ESM should be used instead of CommonJS');
     t.end();
 });
 
diff --git a/packages/plugin-convert-commonjs-to-esm/lib/require/index.js b/packages/plugin-convert-commonjs-to-esm/lib/require/index.js
@@ -22,7 +22,7 @@ const {
 
 const camelCase = (a) => justCamelCase(a.replace('@', ''));
 
-module.exports.report = () => 'ESM should be used insted of Commonjs';
+module.exports.report = () => 'ESM should be used instead of CommonJS';
 
 const __B = 'declarations.0.init.arguments.0';
 
diff --git a/packages/plugin-convert-commonjs-to-esm/lib/require/index.spec.js b/packages/plugin-convert-commonjs-to-esm/lib/require/index.spec.js
@@ -7,7 +7,7 @@ const test = createTest(__dirname, {
 });
 
 test('plugin-convert-commonjs-to-esm: require: transform: report', (t) => {
-    t.report('require', 'ESM should be used insted of Commonjs');
+    t.report('require', 'ESM should be used instead of CommonJS');
     t.end();
 });
 
diff --git a/packages/plugin-convert-commonjs-to-esm/test/convert-commonjs-to-esm.js b/packages/plugin-convert-commonjs-to-esm/test/convert-commonjs-to-esm.js
@@ -7,7 +7,7 @@ const test = createTest(__dirname, {
 });
 
 test('plugin-convert-commonjs-to-esm: transform: report', (t) => {
-    t.report('exports', 'ESM should be used insted of Commonjs');
+    t.report('exports', 'ESM should be used instead of CommonJS');
     t.end();
 });
 
diff --git a/packages/plugin-convert-esm-to-commonjs/lib/convert-esm-to-commonjs.js b/packages/plugin-convert-esm-to-commonjs/lib/convert-esm-to-commonjs.js
@@ -3,7 +3,7 @@
 const {types, template} = require('putout');
 const {isImportDefaultSpecifier} = types;
 
-module.exports.report = () => 'CommonJS should be used insted of ESM';
+module.exports.report = () => 'CommonJS should be used instead of ESM';
 
 module.exports.replace = () => ({
     'export default __a': 'module.exports = __a',
diff --git a/packages/plugin-convert-esm-to-commonjs/test/convert-esm-to-commonjs.js b/packages/plugin-convert-esm-to-commonjs/test/convert-esm-to-commonjs.js
@@ -9,7 +9,7 @@ const test = createTest(__dirname, {
 });
 
 test('plugin-convert-esm-to-commonjs: transform: report', (t) => {
-    t.report('export', 'CommonJS should be used insted of ESM');
+    t.report('export', 'CommonJS should be used instead of ESM');
     t.end();
 });
 
@@ -49,7 +49,7 @@ test('plugin-convert-esm-to-commonjs: transform: specifiers', (t) => {
 });
 
 test('plugin-convert-esm-to-commonjs: report: import default', (t) => {
-    t.report('import-default', ['CommonJS should be used insted of ESM']);
+    t.report('import-default', ['CommonJS should be used instead of ESM']);
     t.end();
 });
 
diff --git a/packages/plugin-putout/README.md b/packages/plugin-putout/README.md
@@ -417,7 +417,7 @@ module.exports.replace = () => ({
 });
 ```
 
-There is no `fix` for this rule, it used internally to be more confident about `test coverage`, because of declaration form, transforms cannon be checked by `nyc` and `c8`, and uncovered lines can find unfixable false possitives when running on code.
+There is no `fix` for this rule, it used internally to be more confident about `test coverage`, because of declaration form, transforms cannon be checked by `nyc` and `c8`, and uncovered lines can find unfixable false positives when running on code.
 This is additional tests, if you forget to test some case (from a big list of rules that is supported) it will be checked with this `rule` and make transforms more stable.
 
 ## declare
diff --git a/packages/plugin-tape/README.md b/packages/plugin-tape/README.md
@@ -66,7 +66,7 @@ While `result` is always a variable, so it most likely much shorter.
 
 ```js
 test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
-    t.eqaul(expected, result);
+    t.equal(expected, result);
     t.end();
 });
 ```
@@ -75,7 +75,7 @@ test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
 
 ```js
 test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
-    t.eqaul(result, expected);
+    t.equal(result, expected);
     t.end();
 });
 ```
diff --git a/packages/putout/lib/codeframe.spec.js b/packages/putout/lib/codeframe.spec.js
@@ -46,7 +46,7 @@ test('putout: codeframe: not highlited', async (t) => {
         loc,
     };
     const source = `
-      fonction(a) {
+      function(a) {
         return a;
       }
     `;
diff --git a/packages/putout/lib/fixture/codeframe b/packages/putout/lib/fixture/codeframe
@@ -1,5 +1,5 @@
   1 |
-> 2 |       fonction(a) {
+> 2 |       function(a) {
     |        ^ some error is here
   3 |         return a;
   4 |       }
diff --git a/packages/test/README.md b/packages/test/README.md
@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/test.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/test "npm"
 
-Test runner for 🐊[**Putout**](https://github.com/coderaiser/putout#plugins-api). Basically it is [supercharged **tape**](https://github.com/coderaiser/supertape) with aditional asseritions:
+Test runner for 🐊[**Putout**](https://github.com/coderaiser/putout#plugins-api). Basically it is [supercharged **tape**](https://github.com/coderaiser/supertape) with additional asseritions:
 
 ## Install
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`>`
`10`	`10`	`> (c) [parceljs](https://parceljs.org/languages/javascript/)`
`11`	`11`
`12`		`-🐊[Putout](https://github.com/coderaiser/putout) plugin adds ability to convert Commonjs to ESM.`
	`12`	`+🐊[Putout](https://github.com/coderaiser/putout) plugin adds ability to convert CommonJS to ESM.`
`13`	`13`
`14`	`14`	`## Install`
`15`	`15`