diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e920c16 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7a56d2a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,3 @@ +language: node_js +node_js: + - "stable" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7487c8e --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# draftjs-prism + +[![Build Status](https://travis-ci.org/SamyPesse/draftjs-prism.png?branch=master)](https://travis-ci.org/SamyPesse/draftjs-prism) +[![NPM version](https://badge.fury.io/js/draftjs-prism.svg)](http://badge.fury.io/js/draftjs-prism) + +`draftjs-prism` is a decorator for DraftJS to highlight code blocks using [Prism](https://github.com/PrismJS/prism). + +![Prism](./preview.gif) + +### Installation + +``` +$ npm install draftjs-prism +``` + +### Usage + +```js +var Draft = require('draft-js'); +var PrismDecorator = require('draftjs-prism'); + +var decorator = new PrismDecorator(); +var editorState = Draft.EditorState.createEmpty(decorator) +``` + +You'll also need to include the css for one of the [Prism themes](https://github.com/PrismJS/prism/tree/gh-pages/themes). \ No newline at end of file diff --git a/lib/index.js b/lib/index.js new file mode 100644 index 0000000..a906f85 --- /dev/null +++ b/lib/index.js @@ -0,0 +1,92 @@ +var Immutable = require('immutable'); +var Prism = require('prism'); + +var PrismOptions = require('./options'); + +var KEY_SEPARATOR = '-'; + +function PrismDecorator(options) { + this.options = PrismOptions(options); + this.highlighted = {}; +} + +/** + Return list of decoration IDs per character + + @param {ContentBlock} + @return {List} +*/ +PrismDecorator.prototype.getDecorations = function(block) { + var tokens, token, tokenId, resultId, offset = 0; + var filter = this.options.get('filter'); + var getSyntax = this.options.get('getSyntax'); + var blockKey = block.getKey(); + var blockText = block.getText(); + var decorations = Array(blockText.length).fill(null); + + this.highlighted[blockKey] = {}; + + if (!filter(block)) { + return Immutable.List(decorations); + } + + // Get grammar + var syntax = getSyntax(block) || this.options.get('defaultSyntax'); + var grammar = Prism.languages[syntax]; + + // Parse text using Prism + tokens = Prism.tokenize(blockText, grammar); + + for (var i =0; i < tokens.length; i++) { + token = tokens[i]; + + if (typeof token === 'string') { + offset += token.length; + } else { + tokenId = 'tok'+offset; + resultId = blockKey + '-' + tokenId; + + that.highlighted[blockKey][tokenId] = token; + + occupySlice(decorations, offset, offset + token.content.length, resultId); + offset += token.content.length; + } + } + + return Immutable.List(decorations); +}; + +/** + Return component to render a decoration + + @param {String} + @return {Function} +*/ +PrismDecorator.prototype.getComponentForKey = function(key) { + return this.options.get('render'); +}; + +/** + Return props to render a decoration + + @param {String} + @return {Object} +*/ +PrismDecorator.prototype.getPropsForKey = function(key) { + var parts = key.split('-'); + var blockKey = parts[0]; + var tokId = parts[1]; + var token = this.highlighted[blockKey][tokId]; + + return { + type: token.type + }; +}; + +function occupySlice(targetArr, start, end, componentKey) { + for (var ii = start; ii < end; ii++) { + targetArr[ii] = componentKey; + } +} + +module.exports = PrismDecorator; diff --git a/lib/options.js b/lib/options.js new file mode 100644 index 0000000..816ce81 --- /dev/null +++ b/lib/options.js @@ -0,0 +1,51 @@ +var Immutable = require('immutable'); + +/** + Filter block to only highlight code blocks + + @param {Draft.ContentBlock} + @return {Boolean} +*/ +function defaultFilter(block) { + return block.getType() === 'code-block'; +} + +/** + Return syntax for highlighting a code block + + @param {Draft.ContentBlock} + @return {String} +*/ +function defaultGetSyntax(block) { + if (block.getData) { + return block.getData().syntax; + } + + return null; +} + +/** + Default render for token + + @param {Object} props + @return {React.Element} +*/ +function defaultRender(props) { + return {props.children}; +} + +var PrismOptions = Immutable.Record({ + // Default language to use + defaultSyntax: String('javascript'), + + // Filter block before highlighting + filter: defaultFilter, + + // Function to get syntax for a block + getSyntax: defaultGetSyntax, + + // Render a decorated text for a token + render: defaultRender +}); + +module.exports = PrismOptions; diff --git a/package.json b/package.json new file mode 100644 index 0000000..27d8014 --- /dev/null +++ b/package.json @@ -0,0 +1,33 @@ +{ + "name": "draftjs-prism", + "version": "0.0.0", + "description": "Code highlighting for DraftJS", + "main": "./lib/index.js", + "scripts": { + "test": "export TESTING=true; mocha --reporter spec --bail" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/SamyPesse/draftjs-prism.git" + }, + "keywords": [ + "draftjs" + ], + "author": "Samy Pesse ", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/SamyPesse/draftjs-prism/issues" + }, + "homepage": "https://github.com/SamyPesse/draftjs-prism#readme", + "dependencies": { + "immutable": "*", + "prismjs": "^1.5.0" + }, + "devDependencies": { + "draft-js": "^0.7.0", + "expect": "^1.20.1", + "mocha": "^2.5.3", + "react": "^15.1.0", + "react-dom": "^15.1.0" + } +} diff --git a/preview.gif b/preview.gif new file mode 100644 index 0000000..734db3f Binary files /dev/null and b/preview.gif differ