feat(lint-md-core): upgrade @lint-md/cli to @lint-md/core v2

.github/workflows/build.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v6.0.2
 
       - name: Install modules
-        run: yarn install
+        run: npm ci
 
       - name: Run tests
-        run: yarn test
+        run: npm test

.gitignore

@@ -1,7 +1,4 @@
 node_modules
 .idea
 .vscode
-coverage
-yarn.lock
-package-lock.json
-.yarnrc.yml
+coverage

README.md

@@ -29,7 +29,7 @@ jobs:
         uses: actions/checkout@v6.0.2
 
       - name: Lint Markdown
-        uses: lint-md/github-action@v0.1.1
+        uses: lint-md/github-action@v0.2.0
         with:
           files: './docs ./'
           configFile: '.lintmdrc'
@@ -54,8 +54,8 @@ jobs:
 {
   "excludeFiles": [],
   "rules": {
-    "space-round-alphabet": 1,
-    "space-round-number": 1,
+    "space-around-alphabet": 1,
+    "space-around-number": 1,
     "no-empty-code-lang": 1,
     "no-trailing-punctuation": 1
   }
@@ -68,8 +68,8 @@ jobs:
 module.exports = {
   excludeFiles: [],
   rules: {
-    "space-round-alphabet": 1,
-    "space-round-number": 1,
+    "space-around-alphabet": 1,
+    "space-around-number": 1,
     "no-empty-code-lang": 1,
     "no-trailing-punctuation": 1
   }
@@ -84,7 +84,7 @@ module.exports = {
 
 ```yaml
 - name: Lint Markdown
-  uses: lint-md/github-action@v0.1.1
+  uses: lint-md/github-action@v0.2.0
   with:
     configFile: './config/.lintmdrc'
 ```

__tests__/github-action.spec.ts

@@ -6,7 +6,6 @@
  * Email: yuzl1123@163.com
  */
 
-
 import * as path from 'path'
 
 import { LintMdAction } from '../src/lint-md-action'
@@ -26,9 +25,9 @@ describe('lint-md GitHub action 测试', () => {
     lintMdAction.showErrorOrPassInfo()
     const totalErrors = lintMdAction.getErrors()
     expect(totalErrors.length).toStrictEqual(1)
-    expect(totalErrors[0].path).toStrictEqual(process.env.GITHUB_WORKSPACE)
-    expect(totalErrors[0].errors.map((tmp: any) => tmp.type)).toStrictEqual([
-      'space-round-alphabet',
+    expect(totalErrors[0].path).toStrictEqual(path.resolve(process.env.GITHUB_WORKSPACE!, 'bad.md'))
+    expect(totalErrors[0].errors.map((tmp: any) => tmp.name)).toStrictEqual([
+      'space-around-alphabet',
       'no-empty-list'
     ])
   })
@@ -41,13 +40,13 @@ describe('lint-md GitHub action 测试', () => {
     await lintMdAction.lint()
     const totalErrors = lintMdAction.getErrors()
     expect(totalErrors.length).toStrictEqual(1)
-    expect(totalErrors[0].path).toStrictEqual(process.env.GITHUB_WORKSPACE)
-    expect(totalErrors[0].errors.map((tmp: any) => tmp.level)).toStrictEqual([
-      'warning',
-      'error'
+    expect(totalErrors[0].path).toStrictEqual(path.resolve(process.env.GITHUB_WORKSPACE!, 'bad.md'))
+    expect(totalErrors[0].errors.map((tmp: any) => tmp.severity)).toStrictEqual([
+      1,
+      2
     ])
-    expect(totalErrors[0].errors.map((tmp: any) => tmp.type)).toStrictEqual([
-      'space-round-alphabet',
+    expect(totalErrors[0].errors.map((tmp: any) => tmp.name)).toStrictEqual([
+      'space-around-alphabet',
       'no-empty-list'
     ])
   })
@@ -60,10 +59,10 @@ describe('lint-md GitHub action 测试', () => {
     await lintMdAction.lint()
     const totalErrors = lintMdAction.getErrors()
     expect(totalErrors.length).toStrictEqual(1)
-    expect(totalErrors[0].path).toStrictEqual(process.env.GITHUB_WORKSPACE)
-    expect(totalErrors[0].errors.map((tmp: any) => tmp.level)).toStrictEqual([
-      'warning',
-      'error'
+    expect(totalErrors[0].path).toStrictEqual(path.resolve(process.env.GITHUB_WORKSPACE!, 'bad.md'))
+    expect(totalErrors[0].errors.map((tmp: any) => tmp.severity)).toStrictEqual([
+      1,
+      2
     ])
   })
 
@@ -106,4 +105,37 @@ describe('lint-md GitHub action 测试', () => {
     const totalErrors = lintMdAction.getErrors()
     expect(totalErrors.length).toStrictEqual(2)
   })
+
+  test('目录递归展开：files 为目录时自动扫描子目录', async () => {
+    process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples')
+    mockAction('./no-config-file ./use-config-file')
+    const lintMdAction = new LintMdAction()
+    await lintMdAction.lint()
+    const errors = lintMdAction.getErrors()
+    expect(errors.length).toStrictEqual(2)
+    expect(errors.every(e => e.path.endsWith('bad.md'))).toBe(true)
+  })
+
+  test('glob pattern 匹配：files 为具体文件路径', async () => {
+    process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples')
+    mockAction('./no-config-file/bad.md')
+    const lintMdAction = new LintMdAction()
+    await lintMdAction.lint()
+    const errors = lintMdAction.getErrors()
+    expect(errors.length).toStrictEqual(1)
+    expect(errors[0].path).toStrictEqual(
+      path.resolve(process.cwd(), 'examples', 'no-config-file', 'bad.md')
+    )
+  })
+
+  test('excludeFiles 排除指定目录', async () => {
+    process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples')
+    mockAction('./', '.lintmdrc')
+    const lintMdAction = new LintMdAction()
+    await lintMdAction.lint()
+    const errors = lintMdAction.getErrors()
+    const paths = errors.map(e => e.path)
+    expect(paths.every(p => !p.includes('only-warning'))).toBe(true)
+    expect(errors.length).toBeGreaterThan(0)
+  })
 })

__tests__/linter.spec.ts

@@ -6,19 +6,33 @@
  * Email: yuzl1123@163.com
  */
 
-
 import * as path from 'path'
-import { Lint } from '@lint-md/cli'
+import * as fs from 'fs'
+import { lintMarkdown } from '@lint-md/core'
+import { glob } from 'glob'
 
 describe('lint 继承对象测试集合', () => {
   test('有 error 出现 (see examples/)', async () => {
-    const newLinter = new Lint([path.resolve(process.cwd(), 'examples')], {
-      rules: {}
+    const mdFiles = await glob(path.resolve(process.cwd(), 'examples') + '/**/*.md', {
+      absolute: true
     })
 
-    await newLinter.start()
-    newLinter.printOverview()
-    expect(newLinter.countError()).toStrictEqual({
+    let errorCount = 0
+    let warningCount = 0
+
+    for (const file of mdFiles) {
+      const content = fs.readFileSync(file, 'utf-8')
+      const result = lintMarkdown(content, {}, false)
+      for (const item of result.lintResult) {
+        if (item.severity === 2) {
+          errorCount++
+        } else if (item.severity === 1) {
+          warningCount++
+        }
+      }
+    }
+
+    expect({ error: errorCount, warning: warningCount }).toStrictEqual({
       'error': 8,
       'warning': 0
     })

examples/.lintmdrc

@@ -0,0 +1,4 @@
+{
+  "excludeFiles": ["**/only-warning/**"],
+  "rules": {}
+}

examples/js-config/.lintmdrc.js

@@ -1,6 +1,6 @@
 module.exports = {
   "excludeFiles": [],
   "rules": {
-    "space-round-alphabet": 1
+    "space-around-alphabet": 1
   }
 }

examples/only-warning/.lintmdrc

@@ -1,6 +1,6 @@
 {
   "excludeFiles": [],
   "rules": {
-    "space-round-alphabet": 1
+    "space-around-alphabet": 1
   }
 }

examples/use-config-file/.lintmdrc

@@ -1,6 +1,6 @@
 {
   "excludeFiles": [],
   "rules": {
-    "space-round-alphabet": 1
+    "space-around-alphabet": 1
   }
 }

examples/use-custom-config/hello

@@ -1,6 +1,6 @@
 {
   "excludeFiles": [],
   "rules": {
-    "space-round-alphabet": 1
+    "space-around-alphabet": 1
   }
 }