https://github.com/dkunin/twiglint

Twig templates linter
https://github.com/dkunin/twiglint

cli lint nodejs twig

Last synced: about 2 months ago
JSON representation

Twig templates linter

• Host: GitHub
• URL: https://github.com/dkunin/twiglint
• Owner: DKunin
• License: mit
• Created: 2017-08-17T18:35:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-31T10:32:21.000Z (over 7 years ago)
• Last Synced: 2024-10-13T12:44:10.361Z (3 months ago)
• Topics: cli, lint, nodejs, twig
• Language: JavaScript
• Size: 69.3 KB
• Stars: 9
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TwigLint [WIP][ALPHA]

Twig templates linter

# Install

```bash

    npm install twiglint -g

```

# Usage

```bash

    Usage

      $ twiglint 

    Options

      -s, --silent Show only errors

      -f, --format Use a specific output format - default: stylish [compact]

      -d, --debug Write debug file, and prepend every check with filename

      -h, --help  This help

```

# Rules to be included

For now rules are hardwired, there will be configurable config, and external plugins in the future

- [x] Warn if there is no only in include function (no-only)

- [x] Variables declared, but not used (no-unused-vars)

- [x] Variables used without declaration, or docblock (no-undeclared)

- [x] Do not use closing bracket on selfclosing tags (`\/>`  => `>`) (no-closed-self-closing-tags)

- [x] Prefer camelcase variable naming (prefer-camel-case-vars)

- [x] Do not use spaceless tag (no-spaceless)

- [x] Wrong tab padding on logic brackets (tags-padding)

- [ ] use staticUrl functions for resources

- [ ] Spelling

# Roadmap

- [x] Write tests for plugins

- [x] Maximum usage of the parser

- [x] Visual reporter with the ability to jump to the needed line (compact)

- [x] Plugins as seperate modules

- [x] cli testing

- [ ] Write pluggable logic for external plugin

- [ ] Allow to use local config

- [ ] Sublime/VSCode/PhpStorm extentions

# Docblock formatting

    {# @param {string} imageLink #}

    {# @param {string} view_change_uri  #}

    {# @param {int} user_location_id #}

or

    {# 

        @param {string} imageLink

        @param {string} view_change_uri 

        @param {int} user_location_id 

    #}

# License

MIT