{"repo":"zhlint-project/zhlint","free":true,"listed":false,"github":"https://github.com/zhlint-project/zhlint","clone":"git clone https://github.com/zhlint-project/zhlint.git","description":"A linting tool for Chinese language.","language":"TypeScript","stars":1012,"topics":["linter","chinese","translation","chinese-language","zhlint"],"license":"MIT","category":"dev-tools","readme_excerpt":"zhlint A linting tool for Chinese text content. How to install You could easily install zhlint through npm or yarn : Usage As CLI The validation report might look like this: Advanced usage zhlint also supports rc and ignore config files for custom rules: In the rc config file, you can write a JSON like: For more details, see supported rules. In the file-ignore file, you can write some lines to ignore files in .gitignore syntax: In the case-ignore file, you can write some lines of ignored cases like: For more details, see setup ignored cases. As Node.js package And the format of validation report is more like this: Advanced usage zhlint also supports rc and ignore config files for custom rules: As a standalone package You could find a JavaScript file dist/zhlint.js as a standalone version. To use it, for example, you can directly add it into your browser as a tag. Then there would be a global variable zhlint for you. API - run(str: string, options?: Options): Result : Lint a certain content. - parameters: - str : The text content you want to lint. - options : Some options to config. - returns: - The result of a single piece of input string. It contains fixed text content as value and the infor of all validations . - report(results: Result[], logger?: Console): void : Print out the validation reports for each file. - parameters: - results : An array for all linted results. - logger : The logger instance, by default it's console in Node.js/browser. - readRc: (dir: string, config","default_branch":null,"files":null,"tree":[],"storefront":"/r/zhlint-project","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/zhlint-project/zhlint/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}