textlint: improve debug log (#1052)

* chore(textlint): add debug log * refactor(textlint): slim debug log
textlint · Feb 2, 2023 · 2df8c67 · 2df8c67
1 parent d5faac3
commit 2df8c67
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 15 deletions.
diff --git a/packages/@textlint/kernel/src/textlint-kernel.ts b/packages/@textlint/kernel/src/textlint-kernel.ts
@@ -136,10 +136,7 @@ export class TextlintKernel {
         if (plugin === undefined) {
             throw new Error(`Not found available plugin for ${ext}`);
         }
-        debug("used plugin %j", {
-            pluginId: plugin.id,
-            availableExtensions: descriptor.availableExtensions
-        });
+        debug("used plugin %j", plugin.id);
         const processor = plugin.processor;
         const { preProcess, postProcess } = processor.processor(ext);
         invariant(
@@ -223,10 +220,7 @@ See https://textlint.github.io/docs/plugin.html`
         if (plugin === undefined) {
             throw new Error(`Not found available plugin for ${ext}`);
         }
-        debug("used plugin %j", {
-            pluginId: plugin.id,
-            availableExtensions: descriptor.availableExtensions
-        });
+        debug("used plugin %j", plugin.id);
         const processor = plugin.processor;
         const { preProcess, postProcess } = processor.processor(ext);
         invariant(

diff --git a/packages/textlint/src/cli.ts b/packages/textlint/src/cli.ts
@@ -29,13 +29,17 @@ const isStdinExecution = (executeOptions: ExecuteOptions): executeOptions is Std
 
 const loadDescriptor = async (cliOptions: CliOptions) => {
     const cliDescriptor = await loadCliDescriptor(cliOptions);
+    debug("cliDescriptor: %j", cliDescriptor);
     const textlintrcDescriptor = cliOptions.textlintrc
         ? await loadTextlintrc({
               configFilePath: cliOptions.config,
               node_modulesDir: cliOptions.rulesBaseDirectory
           })
         : await loadBuiltinPlugins();
-    return cliDescriptor.concat(textlintrcDescriptor);
+    debug("textlintrcDescriptor: %j", textlintrcDescriptor);
+    const mergedDescriptor = cliDescriptor.concat(textlintrcDescriptor);
+    debug("mergedDescriptor: %j", mergedDescriptor);
+    return mergedDescriptor;
 };
 /**
  * Encapsulates all CLI behavior for eslint. Makes it easier to test as well as
@@ -60,6 +64,7 @@ export const cli = {
             return Promise.resolve(1);
         }
         const files = currentOptions._;
+        debug("cliOptions: %j", currentOptions);
         if (currentOptions.version) {
             Logger.log(`v${version}`);
         } else if (currentOptions.init) {

diff --git a/packages/textlint/src/createLinter.ts b/packages/textlint/src/createLinter.ts
@@ -66,8 +66,9 @@ export const createLinter = (options: CreateLinterOptions) => {
             const { availableFiles, unAvailableFiles } = separateByAvailability(targetFiles, {
                 extensions: options.descriptor.availableExtensions
             });
-            debug("Process files", availableFiles);
-            debug("No Process files that are un-support extensions:", unAvailableFiles);
+            debug("Available extensions: %j", options.descriptor.availableExtensions);
+            debug("Process files: %j", availableFiles);
+            debug("No Process files that are un-support extensions: %j", unAvailableFiles);
             return executeFileBackerManger.process(availableFiles, async (filePath) => {
                 const absoluteFilePath = path.resolve(process.cwd(), filePath);
                 const fileContent = await fs.readFile(filePath, "utf-8");
@@ -98,8 +99,9 @@ export const createLinter = (options: CreateLinterOptions) => {
             const { availableFiles, unAvailableFiles } = separateByAvailability(targetFiles, {
                 extensions: options.descriptor.availableExtensions
             });
-            debug("Process files", availableFiles);
-            debug("No Process files that are un-support extensions:", unAvailableFiles);
+            debug("Available extensions: %j", options.descriptor.availableExtensions);
+            debug("Process files: %j", availableFiles);
+            debug("No Process files that are un-support extensions: %j", unAvailableFiles);
             return executeFileBackerManger.process(availableFiles, async (filePath) => {
                 const absoluteFilePath = path.resolve(process.cwd(), filePath);
                 const fileContent = await fs.readFile(filePath, "utf-8");

diff --git a/website/.textlintrc b/website/.textlintrc
@@ -37,7 +37,6 @@
         "weasel",
         "readibility"
       ]
-    },
-    "alex": false
+    }
   }
 }