@textlint/types - npm Package Compare versions

Comparing version 12.0.2 to 12.1.0

lib/src/Plugin/TextlintPluginModule.d.ts

@@ -9,2 +9,10 @@ import { TxtNode } from "@textlint/ast-node-types";
 };
+export declare type TextlintPluginPreProcessResult = TxtNode | {
+    text: string;
+    ast: TxtNode;
+};
+export declare type TextlintPluginPostProcessResult = {
+    messages: Array<any>;
+    filePath: string;
+};
 export interface TextlintPluginProcessorConstructor extends Function {
@@ -37,10 +45,4 @@ new (options?: TextlintPluginOptions): TextlintPluginProcessor;
          */
-        preProcess(text: string, filePath?: string): TxtNode | {
-            text: string;
-            ast: TxtNode;
-        };
-        postProcess(messages: Array<any>, filePath?: string): {
-            messages: Array<any>;
-            filePath: string;
-        };
+        preProcess(text: string, filePath?: string): TextlintPluginPreProcessResult | Promise<TextlintPluginPreProcessResult>;
+        postProcess(messages: Array<any>, filePath?: string): TextlintPluginPostProcessResult | Promise<TextlintPluginPostProcessResult>;
     };
@@ -47,0 +49,0 @@ }

package.json

 {
   "name": "@textlint/types",
-  "version": "12.0.2",
+  "version": "12.1.0",
   "description": "Type definition package for textlint",
@@ -47,8 +47,8 @@ "keywords": [
   "dependencies": {
-    "@textlint/ast-node-types": "^12.0.0"
+    "@textlint/ast-node-types": "^12.1.0"
   },
   "devDependencies": {
-    "@textlint/markdown-to-ast": "^12.0.2",
+    "@textlint/markdown-to-ast": "^12.1.0",
     "@types/mocha": "^8.2.3",
-    "@types/node": "^14.17.5",
+    "@types/node": "^14.17.34",
     "cross-env": "^7.0.3",
@@ -58,5 +58,5 @@ "mocha": "^8.4.0",
     "rimraf": "^3.0.2",
-    "ts-node": "^9.1.1",
-    "ts-node-test-register": "^9.0.1",
-    "typescript": "^4.2.4",
+    "ts-node": "^10.4.0",
+    "ts-node-test-register": "^10.0.0",
+    "typescript": "^4.4.4",
     "unist-util-select": "^3.0.4"
@@ -67,3 +67,3 @@ },
   },
-  "gitHead": "a7826f57258ee6bf68197d983bf5ec71c1b5f565"
+  "gitHead": "a393919e9c77078db47dc14d1baf3ab3a8e1bfcd"
 }

src/Plugin/TextlintPluginModule.ts

@@ -12,2 +12,5 @@ // Plugin
 
+export type TextlintPluginPreProcessResult = TxtNode | { text: string; ast: TxtNode };
+export type TextlintPluginPostProcessResult = { messages: Array<any>; filePath: string };
+
 export interface TextlintPluginProcessorConstructor extends Function {
@@ -44,4 +47,10 @@ new (options?: TextlintPluginOptions): TextlintPluginProcessor;
          */
-        preProcess(text: string, filePath?: string): TxtNode | { text: string; ast: TxtNode };
-        postProcess(messages: Array<any>, filePath?: string): { messages: Array<any>; filePath: string };
+        preProcess(
+            text: string,
+            filePath?: string
+        ): TextlintPluginPreProcessResult | Promise<TextlintPluginPreProcessResult>;
+        postProcess(
+            messages: Array<any>,
+            filePath?: string
+        ): TextlintPluginPostProcessResult | Promise<TextlintPluginPostProcessResult>;
     };
@@ -48,0 +57,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

1120

increased by0.9%

Worsened metrics

Total package byte prevSize

69517

decreased by-39.27%

Dependency changes

• Updated@textlint/ast-node-types@^12.1.0