feat(parser): add support for custom `selfClosing` tags #21

michael-ciniawsky · 2017-12-19T21:09:04Z

`Notable Changes`

adds support for custom selfClosing tags

const parser = require('posthtml-parser')

const html = '<import src="path/to/file.html">'

const tree = parser(options)(html)

[
  {
    tag: 'import'
    attrs: {
      src: 'path/to/file.html'
    }
  }
]

`BREAKING CHANGES`

drops support for node < v4.0.0
parser is curried

parser(options)(html)

`Issues`

Fixes [feat]: set options #3
Fixes [fix]: CDATA is not parsed #11

`PR's`

~~Closes Milestone 0.3.1 #19~~
Closes refactor(index): use htmlparser2/lib/Parser directly #20

michael-ciniawsky · 2017-12-19T22:50:39Z

options.selfClosing might be a better name for this, waiting for feedback here

I could also add support for node < v4.0.0 back, but would really love not to (node < v4.0.0 is EOL more than a year now)

michael-ciniawsky · 2017-12-19T22:51:14Z

lib/parser.js

+
+  const result = []
+
+  const selfClosing = SELF_CLOSING.concat(options.tags || [])


no, ~~you need to add a parameter selfClosing in tree, and~~ check if ~~the tag has a closing slash and~~ does not have content

<customTag />

tag: 'customTag'

I'm not sure I fully understand, are you suggesting to add a selfClosing prop to the node instead ?

{ tag: 'import' selfClosing: true // <= attrs: { ... } }

?

The SELF_CLOSING list of tags might be unneeded here, I definitely need to revisit this once more, maybe I mixed things up here 😛 and we only need to check the node shape
to not have any content, like you suggested

michael-ciniawsky · 2017-12-19T22:52:56Z

lib/parser.js

+  'source',
+  'track',
+  'wbr',
+  // Custom (PostHTML)


Relevant (include might be needed to be removed for now, since this eventually could break existing code)

michael-ciniawsky · 2017-12-19T22:53:12Z

lib/parser.js

+        })
+      }
+
+      if (selfClosing.indexOf(tag) > -1) {


michael-ciniawsky · 2017-12-19T22:53:24Z

lib/parser.js

+
+      if (!buffer.length) {
+        // undefined for selfClosing tags
+        if (node) {


michael-ciniawsky · 2017-12-19T22:54:39Z

The approvals/lgtm check should be removed at best, since the service is offline for a while now and superseded by CODEOWNERS anyways :)

michael-ciniawsky · 2017-12-21T15:14:00Z

options.tags => options.singleTags to be consistent with posthtml-render ?

Scrum · 2017-12-22T14:33:27Z

test/parser.test.js

+      expect(parser(options)(fixture)).to.eql(expected)
+    })
+
+    it('selfClosing', function () {


What is being tested?

#21 (diff), but I need to revisit this PR one more time (today) anyways, currently working on finishing/updating posthtml/posthtml-include#16 so this can finally land soon :)

michael-ciniawsky · 2017-12-26T17:16:07Z

@gitscrum I removed the SELF_CLOSING tag list and the additional option since this is entirely unneeded to support custom selfClosing tags with the current parser. ~~Could you review and verify before I squash the commit please ?~~ Squashed :)

…lts`

laosb · 2018-05-02T09:35:38Z

Any progress?

Scrum · 2018-05-04T07:36:23Z

@laosb Hi, something specific interests you from this PR ?

andrewbanchich · 2018-07-19T20:49:38Z

@Scrum Can this be fast tracked please? Parcel Bundler uses posthtml-parser and as a result anyone using it with self-closing tags has completely broken builds with no workarounds.

Scrum · 2018-07-19T20:57:45Z

@andrewbanchich Hi, describe the case that breaks your build

andrewbanchich · 2018-07-19T21:39:08Z

Any tags that are self-closing don't output correctly. For Vue components, I'll often have <CustomElement /> since I don't need to add anything between.

Scrum · 2018-07-20T08:00:10Z

What is the incorrectness?

andrewbanchich · 2018-07-20T13:22:32Z

Looks like this setting fixed it: parcel-bundler/parcel#1103 (comment)

Thanks though!

michael-ciniawsky requested review from voischev, Scrum and mrmlnc December 19, 2017 21:09

michael-ciniawsky force-pushed the feat/tags branch 3 times, most recently from 5450fcf to b607349 Compare December 19, 2017 21:50

michael-ciniawsky added ci: ok pr: review semver: major status: pending type: feature labels Dec 19, 2017

michael-ciniawsky force-pushed the feat/tags branch from b607349 to 0967b7f Compare December 19, 2017 22:06

michael-ciniawsky commented Dec 19, 2017

View reviewed changes

Scrum reviewed Dec 22, 2017

View reviewed changes

michael-ciniawsky changed the title ~~feat(parser): add tags option (options.tags)~~ feat(parser): add support for custom selfClosing tags Dec 26, 2017

michael-ciniawsky force-pushed the feat/tags branch from b4ea6ba to 0df9c8c Compare December 26, 2017 17:48

michael-ciniawsky added 10 commits December 26, 2017 19:45

chore(.github): add ISSUE_TEMPLATE

63e7e48

chore(.github): add PULL_REQUEST_TEMPLATE

19c2054

chore(.github): add CODEOWNERS

9fdd92c

style: use standard

f012ab3

chore(.gitignore): add .nyc_output

e82fb31

chore(.npmignore): add .nyc_output && coverage

d8ab843

chore(.npmrc): don't generate lockfile

9709c8a

ci(.travis): drop support for node < v4.0.0, add node stable && `…

09d6471

…lts`

docs(LICENSE): update year

b82a87c

test(parser): add && refactor tests

582402b

michael-ciniawsky added 5 commits December 26, 2017 19:46

chore(.editorconfig): cleanup

b4cfeee

docs(PARSER): init JSDoc

908dc81

docs(README): standardize && add tags option (options.tags)

1717447

feat(parser): add support for custom selfClosing tags

ab900c3

chore(package): update dependencies

b5f1625

michael-ciniawsky force-pushed the feat/tags branch from 0df9c8c to b5f1625 Compare December 26, 2017 18:46

michael-ciniawsky mentioned this pull request Dec 27, 2017

[WIP] feat(index): add parser options {Object} (options.parser) posthtml/posthtml#253

Closed

thomasleveil mentioned this pull request Mar 25, 2018

case where formatting the document changes the elements hierarchy mrmlnc/vscode-attrs-sorter#42

Open

Hammster mentioned this pull request Apr 17, 2018

🐛Vue self-closing tags broken on build but fine on dev parcel-bundler/parcel#1103

Closed

michael-ciniawsky closed this Feb 23, 2019

michael-ciniawsky deleted the feat/tags branch February 23, 2019 14:44

michael-ciniawsky removed ci: ok pr: review semver: major status: pending type: feature labels Feb 23, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(parser): add support for custom `selfClosing` tags #21

feat(parser): add support for custom `selfClosing` tags #21

michael-ciniawsky commented Dec 19, 2017 •

edited by Scrum

Loading

michael-ciniawsky commented Dec 19, 2017 •

edited

Loading

michael-ciniawsky Dec 19, 2017

Scrum Dec 22, 2017 •

edited

Loading

michael-ciniawsky Dec 22, 2017 •

edited

Loading

michael-ciniawsky Dec 19, 2017

michael-ciniawsky Dec 19, 2017

michael-ciniawsky Dec 19, 2017

michael-ciniawsky commented Dec 19, 2017

michael-ciniawsky commented Dec 21, 2017

Scrum Dec 22, 2017

michael-ciniawsky Dec 22, 2017

michael-ciniawsky commented Dec 26, 2017 •

edited

Loading

laosb commented May 2, 2018

Scrum commented May 4, 2018

andrewbanchich commented Jul 19, 2018

Scrum commented Jul 19, 2018

andrewbanchich commented Jul 19, 2018

Scrum commented Jul 20, 2018

andrewbanchich commented Jul 20, 2018


		const result = []

		const selfClosing = SELF_CLOSING.concat(options.tags \|\| [])

feat(parser): add support for custom selfClosing tags #21

feat(parser): add support for custom selfClosing tags #21

Conversation

michael-ciniawsky commented Dec 19, 2017 • edited by Scrum Loading

Notable Changes

BREAKING CHANGES

Issues

PR's

michael-ciniawsky commented Dec 19, 2017 • edited Loading

michael-ciniawsky Dec 19, 2017

Choose a reason for hiding this comment

Scrum Dec 22, 2017 • edited Loading

Choose a reason for hiding this comment

michael-ciniawsky Dec 22, 2017 • edited Loading

Choose a reason for hiding this comment

michael-ciniawsky Dec 19, 2017

Choose a reason for hiding this comment

michael-ciniawsky Dec 19, 2017

Choose a reason for hiding this comment

michael-ciniawsky Dec 19, 2017

Choose a reason for hiding this comment

michael-ciniawsky commented Dec 19, 2017

michael-ciniawsky commented Dec 21, 2017

Scrum Dec 22, 2017

Choose a reason for hiding this comment

michael-ciniawsky Dec 22, 2017

Choose a reason for hiding this comment

michael-ciniawsky commented Dec 26, 2017 • edited Loading

laosb commented May 2, 2018

Scrum commented May 4, 2018

andrewbanchich commented Jul 19, 2018

Scrum commented Jul 19, 2018

andrewbanchich commented Jul 19, 2018

Scrum commented Jul 20, 2018

andrewbanchich commented Jul 20, 2018

feat(parser): add support for custom `selfClosing` tags #21

feat(parser): add support for custom `selfClosing` tags #21

michael-ciniawsky commented Dec 19, 2017 •

edited by Scrum

Loading

`Notable Changes`

`BREAKING CHANGES`

`Issues`

`PR's`

michael-ciniawsky commented Dec 19, 2017 •

edited

Loading

Scrum Dec 22, 2017 •

edited

Loading

michael-ciniawsky Dec 22, 2017 •

edited

Loading

michael-ciniawsky commented Dec 26, 2017 •

edited

Loading