feature: @putout/operator-parens: add

coderaiser · coderaiser · commit f9ccb341ba79 · 2025-02-10T13:12:18.000+02:00
diff --git a/packages/operate/README.md b/packages/operate/README.md
@@ -254,39 +254,6 @@ const object = template.ast('x({"a": "b"})');
 const [propertyPath] = traverseProperties(object, 'a');
 ```
 
-### `addParens(path: Path)`
-
-Add parens around expression depending on used `printer`:
-
-- ✅ set `node.extra.parenthesized: true` when `@putout/printer` used;
-- ✅ set add `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
-
-```js
-addParens(path);
-```
-
-### `removeParens(path: Path)`
-
-Remove parens around expression depending on used `printer`:
-
-- ✅ set `node.extra.parenthesized: false` when `@putout/printer` used;
-- ✅ remove `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
-
-```js
-removeParens(path);
-```
-
-### `hasParens(path: Path)`
-
-Check if `path` has parens around expression depending on used `printer`:
-
-- ✅ checks `node.extra.parenthesized` when `@putout/printer` used;
-- ✅ check if parent node type is `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
-
-```js
-hasParens(path);
-```
-
 ## License
 
 MIT
diff --git a/packages/operate/lib/operate.js b/packages/operate/lib/operate.js
@@ -13,12 +13,6 @@ const {renameProperty} = require('./rename-property');
 const {setLiteralValue} = require('./set-literal-value');
 const {getPathAfterRequires} = require('./get-path-after-requires');
 
-const {
-    addParens,
-    removeParens,
-    hasParens,
-} = require('./parens');
-
 const {
     getProperty,
     getProperties,
@@ -54,10 +48,6 @@ module.exports.rename = rename;
 module.exports.renameProperty = renameProperty;
 module.exports.setLiteralValue = setLiteralValue;
 
-module.exports.addParens = addParens;
-module.exports.hasParens = hasParens;
-module.exports.removeParens = removeParens;
-
 module.exports.getProperty = getProperty;
 module.exports.getProperties = getProperties;
 module.exports.traverseProperties = traverseProperties;
diff --git a/packages/operate/test/operate.js b/packages/operate/test/operate.js
@@ -1053,57 +1053,3 @@ test('putout: operate: getLiteralRaw', (t) => {
     t.equal(result, raw);
     t.end();
 });
-
-test('putout: operate: addParens', (t) => {
-    const source = 'const a: boolean = true;';
-    const ast = parse(source, {
-        printer: 'babel',
-        isTS: true,
-    });
-    
-    traverse(ast, {
-        TSBooleanKeyword(path) {
-            operate.addParens(path);
-            path.stop();
-        },
-    });
-    
-    const result = print(ast, {
-        printer: 'babel',
-    });
-    
-    const expected = 'const a: (boolean) = true;\n';
-    
-    t.equal(result, expected);
-    t.end();
-});
-
-test('putout: operate: removeParens', (t) => {
-    const source = '(b = 3)';
-    const ast = parse(source);
-    
-    traverse(ast, {
-        AssignmentExpression: operate.removeParens,
-    });
-    
-    const result = print(ast);
-    const expected = 'b = 3;\n';
-    
-    t.equal(result, expected);
-    t.end();
-});
-
-test('putout: operate: hasParens', (t) => {
-    let result;
-    const source = 'b = 3';
-    const ast = parse(source);
-    
-    traverse(ast, {
-        AssignmentExpression: (path) => {
-            result = operate.hasParens(path);
-        },
-    });
-    
-    t.notOk(result);
-    t.end();
-});
diff --git a/packages/operator-parens/.eslintrc.json b/packages/operator-parens/.eslintrc.json
@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "plugin:n/recommended",
+        "plugin:putout/safe+align"
+    ],
+    "plugins": [
+        "n",
+        "putout"
+    ]
+}
diff --git a/packages/operator-parens/.gitignore b/packages/operator-parens/.gitignore
@@ -0,0 +1,6 @@
+node_modules
+*.swp
+yarn-error.log
+
+coverage
+.idea
diff --git a/packages/operator-parens/.madrun.mjs b/packages/operator-parens/.madrun.mjs
@@ -0,0 +1,13 @@
+import {run} from 'madrun';
+
+export default {
+    'prepublishOnly': () => run(['lint', 'test']),
+    'test': () => `tape 'test/*.js' 'lib/**/*.spec.js'`,
+    'watch:test': async () => `nodemon -w lib -x ${await run('test')}`,
+    'lint': () => 'putout .',
+    'fresh:lint': () => run('lint', '--fresh'),
+    'lint:fresh': () => run('lint', '--fresh'),
+    'fix:lint': () => run('lint', '--fix'),
+    'coverage': async () => `c8 ${await run('test')}`,
+    'report': () => 'c8 report --reporter=lcov',
+};
diff --git a/packages/operator-parens/.npmignore b/packages/operator-parens/.npmignore
@@ -0,0 +1,8 @@
+.*
+*.spec.js
+test
+fixture
+yarn-error.log
+
+coverage
+*.config.*
diff --git a/packages/operator-parens/.nycrc.json b/packages/operator-parens/.nycrc.json
@@ -0,0 +1,15 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "exclude": [
+        "**/*.spec.*",
+        "**/fixture",
+        "test",
+        ".*.*",
+        "**/*.config.*"
+    ],
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100
+}
diff --git a/packages/operator-parens/.putout.json b/packages/operator-parens/.putout.json
@@ -0,0 +1,12 @@
+{
+    "printer": "putout",
+    "match": {
+        "*.md": {
+            "declare": "off",
+            "putout/convert-traverse-to-scan": "off",
+            "putout/apply-remove": "off",
+            "putout/declare": "on"
+        }
+    },
+    "plugins": ["putout"]
+}
diff --git a/packages/operator-parens/LICENSE b/packages/operator-parens/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/operator-parens/README.md b/packages/operator-parens/README.md
@@ -0,0 +1,63 @@
+# @putout/operator-parens [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/operator-parens.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/operator-parens "npm"
+
+🐊[**Putout**](https://github.com/coderaiser/putout) operator adds ability to lint parens.
+
+## Install
+
+```
+npm i putout @putout/operator-parens
+```
+
+## API
+
+### `addParens(path: Path)`
+
+Add parens around expression depending on used `printer`:
+
+- ✅ set `node.extra.parenthesized: true` when `@putout/printer` used;
+- ✅ set add `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
+
+```js
+import {operator} from 'putout';
+
+const {addParens} = operator;
+
+addParens(path);
+```
+
+### `removeParens(path: Path)`
+
+Remove parens around expression depending on used `printer`:
+
+- ✅ set `node.extra.parenthesized: false` when `@putout/printer` used;
+- ✅ remove `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
+
+```js
+import {operator} from 'putout';
+
+const {removeParens} = operator;
+
+removeParens(path);
+```
+
+### `hasParens(path: Path)`
+
+Check if `path` has parens around expression depending on used `printer`:
+
+- ✅ checks `node.extra.parenthesized` when `@putout/printer` used;
+- ✅ check if parent node type is `ParenthesizedExpression` or `TSParenthesizedType` when `babel` used;
+
+```js
+import {operator} from 'putout';
+
+const {hasParens} = operator;
+
+hasParens(path);
+```
+
+## License
+
+MIT
diff --git a/packages/operator-parens/lib/parens.js b/packages/operator-parens/lib/parens.js
diff --git a/packages/operator-parens/lib/parens.spec.js b/packages/operator-parens/lib/parens.spec.js
diff --git a/packages/operator-parens/package.json b/packages/operator-parens/package.json
@@ -0,0 +1,55 @@
+{
+  "name": "@putout/operator-parens",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "🐊Putout operator adds ability to work with parens",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/operator-parens#readme",
+  "main": "lib/parens.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "keywords": [
+    "putout",
+    "putout-operator",
+    "operator",
+    "parens"
+  ],
+  "devDependencies": {
+    "c8": "^10.0.0",
+    "eslint": "^9.0.0",
+    "eslint-plugin-n": "^17.0.0",
+    "eslint-plugin-putout": "^24.0.0",
+    "lerna": "^6.0.1",
+    "madrun": "^10.0.0",
+    "montag": "^1.2.1",
+    "nodemon": "^3.0.1",
+    "putout": "^38.1.1",
+    "supertape": "^10.0.0",
+    "try-catch": "^3.0.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@putout/babel": "^3.0.0"
+  }
+}
diff --git a/packages/putout/lib/putout.js b/packages/putout/lib/putout.js
@@ -130,6 +130,7 @@ module.exports.operator = {
     ...require('@putout/operator-match-files'),
     ...require('@putout/operator-rename-files'),
     ...require('@putout/operator-ignore'),
+    ...require('@putout/operator-parens'),
 };
 
 module.exports.ignores = require('./ignores');
diff --git a/packages/putout/package.json b/packages/putout/package.json
@@ -85,6 +85,7 @@
     "@putout/operator-json": "^2.0.0",
     "@putout/operator-keyword": "^2.0.0",
     "@putout/operator-match-files": "^6.0.1",
+    "@putout/operator-parens": "^1.0.0",
     "@putout/operator-regexp": "^1.0.0",
     "@putout/operator-rename-files": "^2.0.0",
     "@putout/plugin-apply-arrow": "^1.0.0",
diff --git a/packages/putout/test/operator.js b/packages/putout/test/operator.js
@@ -5,7 +5,11 @@ const test = require('supertape');
 const putout = require('..');
 const {keys} = Object;
 const {stringify} = JSON;
-const {operator} = putout;
+const {
+    operator,
+    parse,
+    traverse,
+} = putout;
 
 test('putout: operator: compare', (t) => {
     const result = operator.compare('const a = {}', 'const __ = {}');
@@ -133,3 +137,19 @@ test('putout: operator: isKeyword', (t) => {
     t.ok(result);
     t.end();
 });
+
+test('putout: operate: parens: hasParens', (t) => {
+    let result = false;
+    const source = '(b = 3)';
+    const ast = parse(source);
+    
+    traverse(ast, {
+        AssignmentExpression(path) {
+            result = operator.hasParens(path);
+            path.stop();
+        },
+    });
+    
+    t.ok(result);
+    t.end();
+});
