feature: @putout/operator-regexp: types

Author: coderaiser

packages/operator-regexp/.madrun.js

@@ -1,8 +1,9 @@
 import {run} from 'madrun';
 
 export default {
-    'wisdom': () => run(['lint', 'coverage']),
+    'wisdom': () => run(['lint', 'coverage', 'test:dts']),
     'test': () => `tape 'test/*.js' 'lib/**/*.spec.js'`,
+    'test:dts': () => 'check-dts test/*.ts',
     'watch:test': async () => `nodemon -w lib -x "${await run('test')}"`,
     'lint': () => 'putout .',
     'fresh:lint': () => run('lint', '--fresh'),

packages/operator-regexp/.nycrc.json

@@ -4,6 +4,7 @@
     "exclude": [
         "**/*.spec.*",
         "**/*.config.*",
+        "**/*.ts",
         "**/fixture",
         ".*.*",
         "test"

packages/operator-regexp/lib/regexp.d.ts

@@ -0,0 +1,23 @@
+export function isSimpleRegExp(regexp: RegExp): boolean;
+
+export function getStringFromRegExp(node: {
+    pattern: string;
+}): string;
+
+type RegExpTransformer = {
+    report: (path?: unknown) => string;
+    traverse: (api: {
+        push: (path?: unknown) => void;
+    }) => Record<string, (path?: unknown) => void>;
+    fix: (path?: unknown) => void;
+};
+
+export function transformRegExp(str: string, regExpTransformer: RegExpTransformer): [string, {
+    message: string;
+    position: {
+        column: number;
+        offset: number;
+        line: number;
+    };
+}[]];
+

packages/operator-regexp/package.json

@@ -14,7 +14,9 @@
     "url": "git+https://github.com/coderaiser/putout.git"
   },
   "scripts": {
+    "wisdom": "madrun wisdom",
     "test": "madrun test",
+    "test:dts": "madrun test:dts",
     "watch:test": "madrun watch:test",
     "lint": "madrun lint",
     "fresh:lint": "madrun fresh:lint",
@@ -35,6 +37,7 @@
   ],
   "devDependencies": {
     "@putout/test": "^15.0.0",
+    "check-dts": "^1.0.0",
     "eslint": "^10.0.0",
     "eslint-plugin-putout": "^31.0.0",
     "madrun": "^13.0.0",

packages/operator-regexp/test/errors.ts

@@ -0,0 +1,27 @@
+import {
+    isSimpleRegExp,
+    getStringFromRegExp,
+    transformRegExp,
+} from '../lib/regexp.js';
+
+const noop = () => {};
+// THROWS Argument of type 'number' is not assignable to parameter of type 'RegExp'
+isSimpleRegExp(5);
+// THROWS Expected 1 arguments, but got 0
+isSimpleRegExp();
+// THROWS Argument of type 'number' is not assignable to parameter of type '{ pattern: string; }'
+getStringFromRegExp(5);
+// THROWS Expected 1 arguments, but got 0
+getStringFromRegExp();
+// THROWS Expected 2 arguments, but got 0
+transformRegExp();
+// THROWS Argument of type 'number' is not assignable to parameter of type 'string'
+transformRegExp(5, {
+    report: () => '',
+    fix: noop,
+    traverse: ({push}) => ({
+        RegExp(path) {
+            push(path);
+        },
+    }),
+});

packages/putout/test/operator.errors.ts

@@ -12,40 +12,34 @@ const {
     findFile,
     matchFiles,
     findFileUp,
+    isSimpleRegExp,
 } = operator;
 
 // THROWS Expected 2 arguments, but got 1.
 replaceWith(1);
-
 // THROWS Expected 2-4 arguments, but got 1.
 compare('hello');
-
 // THROWS Expected 2 arguments, but got 1.
 traverse(1);
-
 // THROWS Argument of type 'number' is not assignable to parameter of type 'string'
 toJS(5);
-
 // THROWS Expected 2 arguments, but got 1
 hasTagName(5);
-
 // THROWS Expected 2 arguments, but got 1.
 replaceWith(1);
-
 // THROWS Argument of type 'number' is not assignable to parameter of type 'AddArgsOptions'
 addArgs(5);
-
 // THROWS Argument of type 'number' is not assignable to parameter of type 'DeclareOptions'
 declare(5);
-
 // THROWS Argument of type 'number' is not assignable to parameter of type 'string'
 isKeyword(5);
-
 // THROWS Argument of type 'number' is not assignable to parameter of type 'NodePath_Final'.
 findFile(5, 'hello');
-
 // THROWS Expected 1 arguments, but got 2.
 matchFiles(5, 'hello');
-
 // THROWS Expected 2 arguments, but got 1
 findFileUp(5);
+// THROWS Argument of type 'number' is not assignable to parameter of type 'RegExp'
+isSimpleRegExp(5);
+// THROWS Expected 1 arguments, but got 0
+isSimpleRegExp();

packages/putout/types/operator.ts

@@ -9,5 +9,6 @@ export * from '@putout/operator-ignore';
 export * from '@putout/operator-add-args';
 export * from '@putout/operator-filesystem';
 export * from '@putout/operator-match-files';
+export * from '@putout/operator-regexp';
 export * from '@putout/operator-find-file-up';