feature: @putout/operator-sort-ignore: types

Author: coderaiser

packages/operator-sort-ignore/.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-sort-ignore/.nycrc.json

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

packages/operator-sort-ignore/.putout.json

@@ -1,12 +1,16 @@
 {
-    "printer": "putout",
+    "rules": {
+        "madrun/insert-test-dts": "on",
+        "coverage/add-to-exclude": ["on", {
+            "list": ["**/*.ts"]
+        }]
+    },
     "match": {
         "*.md": {
             "declare": "off",
             "putout/convert-traverse-to-scan": "off",
             "putout/apply-remove": "off",
             "putout/declare": "on"
         }
-    },
-    "plugins": ["putout"]
+    }
 }

packages/operator-sort-ignore/lib/sort-ignore.d.ts

@@ -0,0 +1,10 @@
+import type {Traverser} from '@putout/types/plugin';
+
+type SortIgnoreOptions = {
+    name: string;
+    type?: string;
+    property?: string;
+};
+
+export function sortIgnore(options: SortIgnoreOptions): Traverser;
+

packages/operator-sort-ignore/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",
@@ -30,6 +32,7 @@
     "sort-ignore"
   ],
   "devDependencies": {
+    "check-dts": "^1.0.0",
     "@putout/test": "^15.0.0",
     "eslint": "^10.0.0",
     "eslint-plugin-putout": "^31.0.0",
@@ -53,6 +56,7 @@
   "dependencies": {
     "@putout/babel": "^5.0.0",
     "@putout/operate": "^15.0.0",
-    "@putout/operator-json": "^3.2.0"
+    "@putout/operator-json": "^3.2.0",
+    "@putout/types": "^1.2.0"
   }
 }

packages/operator-sort-ignore/test/errors.ts

@@ -0,0 +1,10 @@
+import {sortIgnore} from '../lib/sort-ignore.js';
+
+// THROWS Argument of type 'number' is not assignable to parameter of type 'SortIgnoreOptions'
+sortIgnore(5);
+
+sortIgnore({
+    name: '.npmignore',
+    // THROWS Type 'number' is not assignable to type 'string'
+    property: 5,
+});

packages/putout/test/operator.errors.ts

@@ -14,6 +14,7 @@ const {
     findFileUp,
     isSimpleRegExp,
     addParens,
+    sortIgnore,
 } = operator;
 
 // THROWS Expected 2 arguments, but got 1.
@@ -60,3 +61,6 @@ isSimpleRegExp();
 
 // THROWS Argument of type 'number' is not assignable to parameter of type 'NodePath_Final'
 addParens(5);
+
+// THROWS Argument of type 'number' is not assignable to parameter of type 'SortIgnoreOptions'
+sortIgnore(5);

packages/putout/types/operator.ts

@@ -12,4 +12,5 @@ export * from '@putout/operator-match-files';
 export * from '@putout/operator-parens';
 export * from '@putout/operator-regexp';
 export * from '@putout/operator-find-file-up';
+export * from '@putout/operator-sort-ignore';