หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

TextLint

เครื่องมือผ้าสำลีที่สามารถทำได้สำหรับข้อความและ markdown

TextLint คล้ายกับ ESLINT แต่ใช้กับภาษาธรรมชาติ

เว็บไซต์

  • การสาธิตออนไลน์
  • เอกสารที่ค้นหาได้
  • รีลีสบล็อก

เยี่ยมชม https://textlint.github.io/

คุณสมบัติ

  • ไม่มีกฎรวม
  • หากต้องการใช้กฎให้ติดตั้งกฎ TextLint ผ่าน NPM
    • npm install textlint-rule-xxx
    • ดูคอลเลกชันของกฎ TextLint
  • ข้อความ Markdown และ Plain ได้รับการสนับสนุนโดยค่าเริ่มต้น การสนับสนุนมีให้สำหรับ HTML และรูปแบบไฟล์อื่น ๆ ผ่านปลั๊กอิน
  • รองรับการใช้ตัวฟอร์ทเตอร์แบบกำหนดเอง

ทัวร์ด่วน

สำหรับการทัวร์อย่างรวดเร็วของ TextLint ให้ชำระเงินคู่มือการเริ่มต้นใช้งานของเรา: กระรอก:

การติดตั้ง

คุณสามารถติดตั้งคำสั่ง textlint โดยใช้ NPM: 

 $ npm install textlint --save-dev

ความต้องการ :

  • node.js 16+

หากคุณไม่แน่ใจว่าคุณกำลังใช้โหนดเวอร์ชันใดคุณสามารถเรียกใช้ node -v ในคอนโซลของคุณเพื่อค้นหา

คำเตือน:

  • หากคุณติดตั้ง textlint ทั่วโลกคุณต้องติดตั้งกฎอ้างอิงแต่ละข้อทั่วโลกเช่นกัน
  • หากคุณติดตั้ง textlint ในเครื่องคุณต้องติดตั้งแต่ละกฎในเครื่องด้วย

เราขอแนะนำให้ติดตั้ง textlint ในเครื่อง

สำหรับผู้เริ่มต้น node.js

หากคุณไม่เคยใช้ node.js และ npm โปรดดูสิ่งต่อไปนี้:

  • การติดตั้ง node.js และอัปเดต NPM | เอกสาร NPM

การใช้งาน

ภาพหน้าจอผ้าสำลีน่ารักน่ารัก

TextLint ไม่มีกฎเริ่มต้น !!

คุณสามารถเรียกใช้ไฟล์ textlint ด้วย .textlintrc.json ไฟล์กำหนดค่า 

 # Install textlint and rules into local directory
npm install --save-dev textlint textlint-rule-no-todo

คำสั่ง npx textlint --init สร้างไฟล์ .textlintrc.json จากกฎที่ติดตั้ง 

npx textlint --init

.textlintrc.json จะถูกสร้างขึ้นเช่นนี้: 

{
    "rules" : {
        "no-todo" : true
    }
}

ไฟล์ผ้าสำลีผ่าน TextLint: 

npx textlint ./README.md

Load textlint .textlintrc.json จากไดเรกทอรีปัจจุบันและ Lint README.md

CLI

เรียกใช้ npx textlint -h สำหรับข้อมูลเกี่ยวกับวิธีการใช้ CLI 

 $ textlint [options] file.md [file|dir|glob*]

Options:
  -h, --help                  Show help.
  -c, --config path::String   Use configuration from this file or sharable config.
  --ignore-path path::String  Specify path to a file containing patterns that describes files to ignore. - default: .textlintignore
  --init                      Create the config file if not existed. - default: false
  --fix                       Automatically fix problems
  --dry-run                   Enable dry-run mode for --fix. Only show result, don't change the file.
  --debug                     Outputs debugging information
  --print-config              Print the config object to stdout
  -v, --version               Outputs the version number.

Using stdin:
  --stdin                     Lint text provided on <STDIN>. - default: false
  --stdin-filename String     Specify filename to process STDIN as

Output:
  -o, --output-file path::String  Enable report to be written to a file.
  -f, --format String         Use a specific output format.

                              Available formatter          : checkstyle, compact, jslint-xml, json, junit, pretty-error, stylish, table, tap, unix

                              Available formatter for --fix: compats, diff, fixed-result, json, stylish - default: stylish
  --no-color                  Disable color in piped output.
  --quiet                     Report errors only. - default: false

Specifying rules and plugins:
  --no-textlintrc             Disable .textlintrc
  --plugin [String]           Set plugin package name
  --rule [String]             Set rule package name
  --preset [String]           Set preset package name and load rules from preset package.
  --rulesdir [path::String]   Use additional rules from this directory

Caching:
  --cache                     Only check changed files - default: false
  --cache-location path::String  Path to the cache file or directory - default: .textlintcache

Experimental:
  --experimental              Enable experimental flag.Some feature use on experimental.
  --rules-base-directory path::String  Set module base directory. textlint load modules(rules/presets/plugins) from the base directory.

เมื่อเรียกใช้ TextLint คุณสามารถกำหนดเป้าหมายไฟล์เพื่อผ้าสำลีโดยใช้รูปแบบลูกโลก ตรวจสอบให้แน่ใจว่าคุณใส่พารามิเตอร์ GLOB ใด ๆ ที่คุณส่งผ่านคำพูด 

$ npx textlint " docs/** "

สำหรับรายละเอียดเพิ่มเติมดูเอกสารประกอบ CLI

  • เอกสาร: CLI

ตัวอย่าง:

  • ดูตัวอย่าง/CLI

.TextLintrc

.textlintrc เป็นไฟล์กำหนดค่าที่โหลดเป็น JSON, YAML หรือ JS ผ่าน AZU/RC-Config-Loader

รันข้อความด้วยอาร์กิวเมนต์ต่อไปนี้ 

 $ npx textlint --rule no-todo --rule very-nice-rule README.md

เทียบเท่ากับการรัน textlint README.md ในไดเรกทอรีที่มี .textlintrc.json ที่มี json ต่อไปนี้ 

{
  "rules" : {
    "no-todo" : true ,
    "very-nice-rule" : true
  }
}

คุณยังสามารถกำหนดค่าตัวเลือกสำหรับกฎเฉพาะในไฟล์ .textlintrc.json ของคุณ 

{
  "rules" : {
    "no-todo" : false , // disable
    "very-nice-rule" : {
        "key" : " value "
    }
  }
}

ตัวอย่างเช่นที่นี่เราผ่านตัวเลือก ("คีย์": "ค่า") ไปยัง very-nice-rule

ตัวเลือกสามารถระบุได้ในไฟล์ .textlintrc.json ของคุณดังนี้: 

 {
  // Allow to comment in JSON
  "rules" : {
    "<rule-name>" : true | false | object
  }
}

สำหรับรายละเอียดเพิ่มเติมดู

  • เอกสาร/การกำหนดค่า
  • ตัวอย่าง/การกำหนดค่าไฟล์

ปลั๊กอิน

ปลั๊กอิน TextLint เป็นชุดของกฎและ rulesconfig หรือปรับแต่งตัวแยกวิเคราะห์

ในการเปิดใช้งานปลั๊กอินให้ใส่ "ปลั๊กอินชื่อ" ลงใน .textlintrc.json 

 // `.textlintrc.json`
{
    "plugins" : [
        "plugin-name"
    ] ,
    // overwrite-plugins rules config
    // <plugin>/<rule>
    "rules" : {
        "plugin-name/rule-name" : false
    }
}

ดู docs/plugin.md

รูปแบบไฟล์ที่รองรับ

TextLint รองรับ markdown และข้อความธรรมดาโดยค่าเริ่มต้น

ติดตั้ง ปลั๊กอินโปรเซสเซอร์ และเพิ่มการสนับสนุนรูปแบบไฟล์ใหม่

ตัวอย่างเช่นหากคุณต้องการผ้าสำลี HTML ให้ใช้ TextLint-Plugin-HTML เป็นปลั๊กอิน 

 npm install textlint-plugin-html --save-dev

เพิ่ม "html" เป็น .textlintrc.json 

 {
    "plugins": [
        "html"
    ]
}

เรียกใช้ textlint บนไฟล์ .html :

textlint index.html

  • ตัวอย่าง: ตัวอย่าง/html-plugin
  • เอกสาร: docs/plugin.md

ประเภทไฟล์ที่รองรับเสริม:

  • html: textlint-plugin-html
  • ปรับโครงสร้างข้อความ: textlint-plugin-rst
    • ส้อม: Shiguredo/textlint-plugin-rst
  • asciidoc/asciidoctor: textlint-plugin-asciidoc-loose
  • Re: ดู: textlint-plugin-review
  • org-mode: textlint-plugin-org

ดูรายการปลั๊กอินโปรเซสเซอร์สำหรับรายละเอียด

รายชื่อกฎ

  • ตรวจสอบ: คอลเลกชันของ TextLint Rule · TextLint/TextLint Wiki

TextLint ไม่ได้มีกฎในตัว แต่มีกฎที่สามารถเสียบได้มากกว่า 100 รายการ:

  • textlint-rule-no-todo
  • textlint-rule-max-number-lines
  • textlint-rule-common-misspellings
  • ฯลฯ ...

ดูคอลเลกชันของ TextLint Rule · TextLint/TextLint Wiki สำหรับรายละเอียดเพิ่มเติม

หากคุณสร้างกฎใหม่และเพิ่มลงในวิกิ :)

แน่นอน

กฎบางอย่างสามารถแก้ไขได้โดยใช้ธงบรรทัดคำสั่ง --fix 

$ npx textlint --fix README.md
# As a possible, textlint fix the content.

แก้ไขข้อผิดพลาดได้

นอกจากนี้รองรับโหมด Dry Run 

 $ npx textlint --fix --dry-run --format diff README.md
# show the difference between fixed content and original content.

คุณสามารถคัดลอกและวางลงใน readme ของคุณ 

 [ ![ textlint fixable rule ] ( https://img.shields.io/badge/textlint-fixable-green.svg?style=social )] ( https://textlint.github.io/ )

Formatters ในตัว

ใช้ Formatters ต่อไปนี้:

  • มีสไตล์ (ค่าเริ่มต้น)
  • กะทัดรัด
  • CheckStyle
  • jslint-xml
  • จูท
  • แตะ
  • โต๊ะ
  • ข้อผิดพลาด
  • JSON
  • Unix

เช่นใช้รูปแบบ pretty-error : 

 $ npx textlint -f pretty-error file.md

รายละเอียดเพิ่มเติมใน @textlint/linter-formatter

ใช้เป็นโมดูลโหนด

คุณสามารถใช้ TextLint เป็นโมดูลโหนด 

 $ npm install textlint --save-dev

การใช้งานขั้นต่ำ: 

 import { createLinter , loadTextlintrc , loadLinterFormatter } from "textlint" ;
const descriptor = await loadTextlintrc ( ) ;
const linter = createLinter ( { descriptor } ) ;
const results = await linter . lintFiles ( [ "*.md" ] ) ;
// textlint has two types formatter sets for linter and fixer
const formatter = await loadLinterFormatter ( { formatterName : "stylish" } ) ;
const output = formatter . format ( results ) ;
console . log ( output ) ;

ข้อมูลรายละเอียดเพิ่มเติมโปรดอ่านเอกสารต่อไปนี้:

  • ดู docs/use-as-modules.md

@TextLint/เคอร์เนลเป็น API ระดับต่ำสำหรับ TextLint มันมีประโยชน์สำหรับสภาพแวดล้อมของเบราว์เซอร์หรือไม่ใช่ node.js 

 import { TextlintKernel } from "@textlint/kernel" ;
const kernel = new TextlintKernel ( ) ;
const options = {
    filePath : "/path/to/file.md" ,
    ext : ".md" ,
    plugins : [
        {
            pluginId : "markdown" ,
            plugin : require ( "@textlint/textlint-plugin-markdown" )
        }
    ] ,
    rules : [
        {
            ruleId : "no-todo" ,
            rule : require ( "textlint-rule-no-todo" ) . default
        }
    ]
} ;
kernel . lintText ( "TODO: text" , options ) . then ( result => {
    assert . ok ( typeof result . filePath === "string" ) ;
    assert . ok ( result . messages . length === 1 ) ;
} ) ;

บทสรุป

TextLint มีสี่จุดขยายได้:

  • กฎ
    • กฎเป็นกฎสำหรับการผ้าสำลี
  • กฎตัวกรอง
    • กฎตัวกรองเป็นกฎสำหรับการกรองผลลัพธ์ของข้อผิดพลาด
  • การกำหนดกฎ
    • กฎข้อบังคับมีกฎ
  • ปลั๊กอิน
    • ปลั๊กอินมีโปรเซสเซอร์

กฎ-preset-plugin

คำถามที่พบบ่อย: จะสร้างกฎได้อย่างไร?

โปรดดูเอกสาร/

  • docs/txtnode.md
    • txtnode คืออะไร?
  • docs/rule.md
    • จะสร้างกฎได้อย่างไร?
    • การสอน: การสร้างกฎ no-todo
  • docs/rule- advanced.md
    • การสอนขั้นสูงสำหรับการสร้างกฎ

คำถามที่พบบ่อย: วิธีระงับข้อผิดพลาดโดยความคิดเห็นเช่น <!-- textlint-disable --> ?

คุณสามารถใช้กฎตัวกรองเช่น textlint-filter-rule-comments

โปรดดูการละเว้นข้อความ· TextLint สำหรับรายละเอียดเพิ่มเติม

การรวมกัน

สำหรับรายละเอียดเพิ่มเติมดูเอกสารการรวม

แอป

  • TextLint-App
    • แอพแพลตฟอร์มข้ามแบบสแตนด์อโลน ไม่จำเป็นต้องมีสภาพแวดล้อม node.js

สร้างระบบ

  • ปลั๊กอินอึก
    • Gulp-textlint
  • ปลั๊กอินคำราม
    • คำพูดคร่ำครวญ

บรรณาธิการ

  • Atom Editor
    • 1,000ch/linter-textlint
  • sublimetext
    • Joeybaker/Sublimelinter-textlint
  • vim
    • vim-textlint
    • Scrooloose/syntastic
      • ดู Markdown, Text และ HTML ของ scrooloose/syntastic wiki
  • รหัส VS
    • taichi/vscode-textlint
  • จุลภาค
    • Hidaruma/Micro-textlint-plugin
  • เน็ตเวิร์ก
    • NetBeans-textlint-plugin

เบราว์เซอร์

  • ส่วนขยายโครเมี่ยม
    • Chrome: TextLint-ProfoReader
    • io-monad/textlint-chrome-extension: TextLint Chrome Extension

อื่น

  • Pronto: Pronto-textlint
  • ReviewDog: Azu/TextLint-Reviewdog-Example

ใครใช้ TextLint?

  • SurviveJS/WebPack-Book
  • hoodiehq/hoodie
  • asciidwango/js-primer
  • vuejs-jp/vuejs.org
  • Cypress-IO/Cypress-Molumentation

แพ็คเกจ

ที่เก็บนี้เป็น monorepo ที่เราจัดการโดยใช้ Lerna นั่นหมายความว่าเราเผยแพร่แพ็คเกจหลายฉบับให้กับ NPM จาก codebase เดียวกันรวมถึง:

แกนกลาง

โมดูลเหล่านี้เป็นส่วนหนึ่งของ TextLint

บรรจุุภัณฑ์ รุ่น คำอธิบาย
textlint เครื่องมือบรรทัดคำสั่ง textlint เอง
@textlint/kernel โมดูลลอจิกหลักของ TextLint มันเป็นจาวาสคริปต์สากล
@textlint/linter-formatter Formatter เอาต์พุต TextLint
@textlint/fixer-formatter TextLint Output Formatter สำหรับ Fixer
@textlint/textlint-plugin-markdown การสนับสนุน Markdown สำหรับ textlint
@textlint/textlint-plugin-text รองรับข้อความธรรมดาสำหรับ TextLint
@textlint/ast-tester การทดสอบการปฏิบัติตามกฎระเบียบสำหรับ AST ของ TextLint
@textlint/markdown-to-ast ตัวแยกวิเคราะห์ Markdown
@textlint/ast-traverse TxtNode Traverse Library
@textlint/text-to-ast ตัวแยกวิเคราะห์ข้อความธรรมดา
@textlint/config-loader โหลดไฟล์กำหนดค่า. TEXTLINTRC

กฎ/ปลั๊กอินช่วย

โมดูลเหล่านี้มีประโยชน์สำหรับผู้เขียน TextLint Rule/Plugin

บรรจุุภัณฑ์ รุ่น คำอธิบาย
@textlint/ast-node-types TextLint AST (บทคัดย่อไวยากรณ์ทรี) คำจำกัดความประเภท
textlint-tester เครื่องมือทดสอบกฎ TextLint
textlint-scripts TextLint กฎ npm run-scripts
create-textlint-rule สร้างกฎ TextLint โดยไม่มีการกำหนดค่าการสร้าง

การรวมกัน

โมดูลเหล่านี้เป็นการรวมที่มีประโยชน์กับ TextLint

บรรจุุภัณฑ์ รุ่น คำอธิบาย
gulp-textlint Gulp Plugin สำหรับ TextLint

ภายใน

โมดูลเหล่านี้คือการใช้งานภายในในโมโนเรป

บรรจุุภัณฑ์ รุ่น คำอธิบาย
@textlint/feature-flag ตัวจัดการธงฟีเจอร์

นโยบายการกำหนดเวอร์ชันความหมาย

TextLint Project ติดตามการกำหนดเวอร์ชันความหมาย อย่างไรก็ตาม TextLint ไม่แตกต่างกันกับโครงการ SEMVER ส่วนใหญ่

  • Patch Release (ตั้งใจที่จะไม่ทำลายผ้าสำลีของคุณ)
    • การแก้ไขข้อผิดพลาดไปยัง CLI หรือ CORE (รวมถึง Formatters)
    • การปรับปรุงเอกสาร
    • การเปลี่ยนแปลงที่ไม่ใช่ผู้ใช้เช่น refactoring
    • รีลีสอีกครั้งหลังจากการเปิดตัวที่ล้มเหลว (เช่นการเผยแพร่รุ่นที่ไม่ได้ผลสำหรับใคร)
  • การเปิดตัวเล็กน้อย (อาจทำลายผ้าสำลีของคุณ)
    • ตัวเลือกใหม่
    • กฎที่มีอยู่เลิกใช้แล้ว
    • ความสามารถ CLI ใหม่ถูกสร้างขึ้น
    • API สาธารณะใหม่จะถูกเพิ่ม (คลาสใหม่, วิธีการใหม่, อาร์กิวเมนต์ใหม่กับวิธีการที่มีอยู่ ฯลฯ )
      • มันอาจทำลายอินเทอร์เฟซประเภท ( .d.ts )
    • มีการสร้างฟอร์แมตใหม่
  • Major Release (ทำลายผ้าสำลีของคุณ)
    • ตัวเลือกใหม่สำหรับกฎที่มีอยู่ซึ่งส่งผลให้ข้อความรายงานข้อผิดพลาดมากขึ้นตามค่าเริ่มต้น
    • รูปแบบที่มีอยู่จะถูกลบออก
    • ส่วนหนึ่งของ API สาธารณะจะถูกลบออกหรือเปลี่ยนแปลงในวิธีที่เข้ากันไม่ได้

การบริจาค

สำหรับข้อบกพร่องและคำขอคุณสมบัติโปรดสร้างปัญหา

คำขอดึงยินดีต้อนรับเสมอ

สำหรับรายละเอียดเพิ่มเติมดูคู่มือการสนับสนุน

ใบอนุญาต

mit © azu

คัดลอกรหัสบางส่วนจาก ESLINT 

 ESLint
Copyright (c) 2013 Nicholas C. Zakas. All rights reserved.
https://github.com/eslint/eslint/blob/master/LICENSE

โลโก้และไอคอน

ดาวน์โหลดจาก TextLint/Media

งานที่เกี่ยวข้อง

  • SCG: TextLint

กิตติกรรมประกาศ

ขอบคุณ Eslint

เว็บไซต์ TextLint ใช้พลังงานจาก NetLify

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด