pugjs/pug

Official and maintained Grammar definition file

Open

#2924 opened on Dec 12, 2017

View on GitHub
 (6 comments) (12 reactions) (0 assignees)JavaScript (21,509 stars) (1,955 forks)batch import
Good First Issue

Description

Every code editor I tried so far has incomplete or incorrect implementation of Pug syntax. Thus development with Pug lacks proper tooling, often breaks without a reason and is inefficient.

One way to solve this would be maintaining official grammar under pugjs organization. Like what for ex. TypeScript has. It will allow to join time of contributors together and maintain the single codebase.

The widely used format is the TextMate Language grammar .tmLanguage (which doesn't support context though). All these editors accepts it:

The next step would be to pick the best implementation, fix its issues and start from there.

Ideas, opinions?

❤️

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TextMate grammar basicsJavaScript/Node.jsfamiliarity with code editors
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Start by evaluating the two existing grammar implementations linked in the issue (davidrios/pug tmbundle and genoma/language pug). Identify common syntax errors or omissions. Then create a new repository under pugjs organization and port the best parts, fixing issues. Consider using the same format as TypeScript TmLanguage for consistency. Engage with community for feedback.