chapel-lang/highlightjs-chapel

Please include `dist` folder with CDN distributable

Closed this issue · 1 comments

joshgoebel commented

This issue is being opened as part of our iniative to make all 3rd party grammars:

  • easier to use for all end users
  • internally a bit more consistent (both to help end users and also encourage cross-maintenance)
  • ready to go for version 11

Please include a dist folder that includes a ready-to-go CDN distributable that can be used with a single line of JS. IE, our simple 3 install should "just work" without any other code or markup:

<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/highlightjs-chapel/chapel.js"></script>
<script type="text/javascript">hljs.highlightAll();</script>

Your README optimally would also document this usage. Please see the robots-txt repository for a usage example.

Our build system can generate this file for you (and we recommend that). Using our internal build system also allows you to easily check your grammar for exponential or polynomical run-away regular expressions.

If you have any questions, feel free to ask!

Thanks,
Highlight.js Maintainer

bradcray commented

Adding this list from highlightjs/highlight.js#3008 for my own reference:

  • Your primary JS file should only set a default export, no others
  • Remove any other definer and/or other additional exports
  • Your repository should include a dist folder with pre-built CDN assets. Reference: 3RD_PARTY_QUICK_START.md.md
  • Remove any browser shims from your raw JS source
  • Consider adding a package.json and publishing your grammar on NPM if you aren't already
  • Please update your README.md if necessary to reflect these changes
  • Remove charset="UTF-8" from your examples, it should no longer be necessary with dist builds produced by our build tools