Nothing Special   »   [go: up one dir, main page]

Skip to content

textlint/textlint-app

Repository files navigation

textlint-app Build Status Build status

textlint app for cross platform.

gif

Why?

  • Not require Node.js/npm on your environment.
  • Just download binary and launch app.

Install

Download Binary from https://github.com/textlint/textlint-app/releases/latest

Features

  • No dependencies
    • Just install and run it
  • Cross platform
  • Support .textlintrc
    • You can use existing .textlintrc config
  • Support --fix
    • Automatically fix lint error
  • TODO:
    • Support only markdown #8
    • Improve performance #9

Usage

  1. Open textlint app
  2. Go to "Setting" tab
  3. Setup .textlintrc
  4. Press "Install"!
  5. Edit with textlint

Example

.textlintrc:

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

Result:

image

Development

You can install textlint-app in local environment.

yarn install
yarn run bootstrap
yarn run watch
yarn run electron

Update packages

If you update packages/ modules

yarn run publish
# It bump version, not publish to npm

Update packages/ dependencies

yarn upgrade

TODO: file: is not linked by lerna... We will improve this.

Changelog

See Releases page.

Running tests

Install devDependencies and Run yarn test:

yarn test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu