2.0.0 Roadmap

[ForbesLindesay]

This is a place-holder issue for the 2.0.0 roadmap. I currently plan to close all issues that don't absolutely need to be fixed in the v1 branch. Then release v1.9.2. At this point, we will have a freeze on v1 features, except additional warnings that can become errors in v2.0.0. I will then merge the ongoing 2.0.0 work into master.

[ForbesLindesay]

The next release will be the final 1.x.x release. At that point I will merge in the refactoring work and begin working on the 2.0.0 change log.

[ForbesLindesay]

I created a branch at https://github.com/jadejs/jade/tree/v1.x.x which can be used for any bug fixes on 1.x.x, but I actively want to discourage working on that branch unless major bugs are discovered because it will ultimately just slow 2.0.0 down.

Tasks to be completed before releasing 2.0.0:

Done

These changes have been made already:

• Separate lexer/parser/loader/linker/code-gen into separate modules
• Remove CLI from core (Remove CLI from core jade module #1993)
• Remove pre-built binaries from core (Remove pre-built binaries #1992)
• Fix mixin blocks followed by whitespace disappearing (The depth of nested mixin is limited? #1999)
• Treat - followed by a newline as an "Empty Statement" (inline javascript gets confused by blank lines #1916)
• Fix bug where some tags get recognised as keywords and visa versa (Can't render a tag beginning with "default" #1750 Add tests for error reporting and report more errors pug-lexer#4)
• Support nesting filters (Nesting Filters, e.g. :cdata and :uglify-js #1997 Add support for nested filters pug-parser#6)
• Investigate possible mixins bug (Propagating mixins to includes #1979)
• Check that we don't have any code using un-guarded for/in loops (I have this error: #1892)
• Support ES6 multi-line strings in attributes (Allow new lines in the attributes text #1969)
• Check that mixins ignore white space after the call (Trailing tabs are not stripped from mixin calls #1898)
• Ensure that multi-line interpolation reports a helpful error message (Escaping and Multiline when using #[ ] #1723)
• Force the compiler to generate a new statement every n (where n is somewhere between 10 and 200) concatenations (RangeError: Maximum call stack size exceeded when compileDebug is false #1846 Terse mode only enabled after the doctype has been processed #1918 Break the buffering every 100 concatenations pug-code-gen#11)
• Mark textarea as whitespace sensitive (Whitespace in textarea #1931 Mark <textarea> as whitespace sensitive pug-code-gen#9)
• Add space after inline comments (Missing space after inline comment #1942)
• Stop treating unbuffered comments as a block (Unbuffered comments are treated as block... #1954 Use jade-strip-comments #2043)
• Fix issue with Comma-First + Tabs - just needs us to be consistent between tabs and spaces (Lines starting with <tabs> <comma> are not parsed correctly #1800 Add test cases for multiline attributes #2047 Add support for for multiline attributes using tabs and commas pug-lexer#10)
• Possibly sort attributes for better compression (Optimise Attribute Order for Compression #1793 and single class and attribute order #1914 Always put class in the front pug-attrs#6 Reorder class as the first attribute pug-runtime#16)
• Consider supporting . that is not attached to a tag (Combining plain text and tags #1939 Allow "dot" that is not attached to a tag pug-parser#12)
• Support first line of pipeless text being indented (Support the first line of pipeless-text being indented #1588 Fix pipeless text indentation detection – less intrusive version pug-lexer#16)
• Ensure that line numbers are included in the "no closing bracket found" error (The end of the string was reached with no closing bracket found. #1922 Better error report for interpolation bracket mismatch pug-code-gen#14)
• Check that mis-matched brackets result in the correct error for interpolation (Mismatched brackets work with interpolation #1871 Add test cases for inline tags and #1871 #2049 Fix inline tag with code pug-lexer#11)
• Support nested filters (including on include) (Figuring out the AST for filters and filtered includes #2154 Nesting filters for includes #2126)

Fix Ready

These changes have a pull request waiting to be merged:

• Scan entire AST for doctype before compiling (Terse mode only enabled after the doctype has been processed #1918 Walk the entire AST to look for the doctype pug-code-gen#10)

Blocking

The following issues must be resolved before 2.0.0 can be released

• Implement plugin API (Customizing Jade #2133)
• Rename to Pug (Renaming jade -> pug #2184)
• Passing tests for every module

High Priority

These issues are technically non-breaking changes, so they could be left until after the 2.0.0 release, but it would be a huge win to get them resolved before then.

• Empty!

Discussions

We should make a decision about the following issues before releasing 2.0.0

• Empty!

Low Priority

These items are nice to have, but we could leave them.

• Break pretty printing into a separate module (Use HTML prettifier #1123)
• Document and validate options passed to jade.compile etc. (Option type checking #1728)
• Decide on whether to implement a shorter syntax for &attributes (Alternative syntax for &attributes #1744)
• Allow users to explicitly specify all globals and not allow implicit globals, resulting in better performance (All global variables are accessible now making options.globals pointless #1773)
• Look for opportunities to catch more errors (Detect empty loop #1825)
• Consider supporting a default block in template inheritance (Default/implicit block when extending layout #1902)

[TimothyGu]

All non-low-priority issues have been solved. \o/

[ForbesLindesay]

I've added two more "Blocking" items. Everything in low priority can be left till the next milestone.

[ForbesLindesay]

I've released an initial alpha:

https://www.npmjs.com/package/pug

[email protected]

It would be great if as many people as possible could try this out and report any issues they find.

[alubbe]

Great release. Works for me, and the performance looks wonderful. We've gotten so much faster 👍

[TimothyGu]

Most of these have been solved.