remark - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "remark",
-  "description": "A markdown parser built for speed",
-  "author": "Christopher Jeffrey",
-  "version": "0.0.1",
-  "main": "./lib/marked.js",
-  "bin": "./bin/marked",
-  "man": "./man/marked.1",
-  "preferGlobal": true,
-  "repository": "git://github.com/jonathanong/remark.git",
-  "homepage": "https://github.com/jonathanong/remark",
-  "bugs": { "url": "http://github.com/jonathanong/remark/issues" },
-  "keywords": ["markdown", "markup", "html"],
-  "tags": ["markdown", "markup", "html"],
+  "version": "0.1.0",
+  "description": "Forward-looking Markdown editor built in React",
+  "main": "index.js",
+  "scripts": {
+    "build": "browserify -s Remark -t brfs index.js > dist/remark.js",
+    "component": "browserify -x react -s Remark -t brfs component.js > dist/component.js",
+    "minify": "uglifyjs dist/remark.js > dist/remark.min.js && uglifyjs dist/component.js > dist/component.min.js",
+    "test": "mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iceddev/remark"
+  },
+  "keywords": [
+    "react",
+    "component",
+    "markdown",
+    "editor",
+    "blog",
+    "post"
+  ],
+  "author": "Blaine Bublitz <[e-mail]> (http://iceddev.com/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/iceddev/remark/issues"
+  },
+  "homepage": "https://github.com/iceddev/remark",
+  "dependencies": {
+    "envify": "^1.2.1",
+    "fluxxor": "^1.2.0",
+    "insert-css": "^0.1.1",
+    "lodash": "git+ssh://[e-mail]:lodash/lodash#79829aec234e9a5deb04616dd228f710ac2b08f7",
+    "marked": "^0.3.2",
+    "react": "^0.10.0"
+  },
   "devDependencies": {
-    "markdown": "*",
-    "showdown": "*",
-    "robotskirt": "*"
+    "brfs": "^1.1.1",
+    "browserify": "^4.1.8",
+    "chai": "^1.9.1",
+    "mocha": "^1.20.1",
+    "uglify-js": "^2.4.13",
+    "watchify": "^0.10.2"
   },
-  "scripts": { "test": "node test", "bench": "node test --bench" }
-}
+  "browserify": {
+    "transform": [
+      "brfs"
+    ]
+  }
+}

README.md

@@ -1,330 +0,57 @@
-# remark
+remark
+======
 
-> A full-featured markdown parser and compiler, written in javascript. Built
-> for speed.
+Forward-looking Markdown editor built in React
 
-Fork of [marked](https://github.com/chjj/marked).
-Will pull all commits from master.
-Pull requests welcome.
+## The `remark` npm package has recently changed!
 
-[![Build Status](https://travis-ci.org/jonathanong/remark.png)](https://travis-ci.org/jonathanong/remark)
-[![NPM version](https://badge.fury.io/js/remark.png)][badge]
+If you're looking for jongleberry's `remark` project, you can install with `npm install remark@0.0.1`.
 
-## Install
-
-``` bash
-npm install marked --save
-```
-
 ## Usage
 
-Minimal usage:
+`remark` exposes a render method from the main package.
 
 ```js
-console.log(marked('I am using __markdown__.'));
-// Outputs: <p>I am using <strong>markdown</strong>.</p>
+var remark = require('remark');
+
+var editor = remark(document.getElementById('editor'));
 ```
 
-Example using all options:
+Layout of the component is controlled by CSS Flexbox and works best if placed in an element with `display: flex` styling.
 
-```js
-// Set default options except highlight which has no default
-marked.setOptions({
-  gfm: true,
-  highlight: function (code, lang, callback) {
-    pygmentize({ lang: lang, format: 'html' }, code, function (err, result) {
-      if (err) return callback(err);
-      callback(null, result.toString());
-    });
-  },
-  tables: true,
-  breaks: false,
-  pedantic: false,
-  sanitize: true,
-  smartLists: true,
-  smartypants: false,
-  langPrefix: 'lang-'
-});
-
-// Using async version of marked
-marked('I am using __markdown__.', function (err, content) {
-  if (err) throw err;
-  console.log(content);
-});
+```css
+/* Full Page editor */
+body {
+  display: flex;
+  min-height: 100vh;
+}
 ```
 
-## marked(markdownString, [options], [callback])
-
-### markdownString
-
-Type: `String`
-
-String of markdown source to be compiled.
-
-### options
-
-Type: `Object`
-
-Hash of options. Can also be set using the `marked.setOptions` method as seen
-above.
-
-### callback
-
-Type: `Function`
-
-Function called when the `markdownString` has been fully parsed when using
-async highlighting. If the `options` argument is omitted, this can be used as
-the second argument as seen above:
-
-## Options
-
-### gfm
-
-Type: `Boolean`
-Default: `true`
-
-Enable [GitHub flavored markdown][gfm].
-
-### highlight
-
-Type: `Function`
-
-A function to highlight code blocks. The function takes three arguments: code,
-lang, and callback. The above example uses async highlighting with
-[node-pygementize-bundled][pygmentize], and here is a synchronous example using
-[highlight.js][highlight] which doesn't require the callback argument:
-
 ```js
-marked.setOptions({
-  highlight: function (code, lang) {
-    return hljs.highlightAuto(lang, code).value;
-  }
-});
-```
+var remark = require('remark');
 
-#### highlight arguments
-
-`code`
-
-Type: `String`
-
-The section of code to pass to the highlighter.
-
-`lang`
-
-Type: `String`
-
-The programming language specified in the code block.
-
-`callback`
-
-Type: `String`
-
-The callback function to call when using an async highlighter.
-
-### tables
-
-Type: `Boolean`
-Default: `true`
-
-Enable GFM [tables][tables].
-This option requires the `gfm` option to be true.
-
-### breaks
-
-Type: `Boolean`
-Default: `false`
-
-Enable GFM [line breaks][breaks].
-This option requires the `gfm` option to be true.
-
-### pedantic
-
-Type: `Boolean`
-Default: `false`
-
-Conform to obscure parts of `markdown.pl` as much as possible. Don't fix any of
-the original markdown bugs or poor behavior.
-
-### sanitize
-
-Type: `Boolean`
-Default: `false`
-
-Sanitize the output. Ignore any HTML that has been input.
-
-### smartLists
-
-Type: `Boolean`
-Default: `true`
-
-Use smarter list behavior than the original markdown. May eventually be
-default with the old behavior moved into `pedantic`.
-
-### smartypants
-
-Type: `Boolean`
-Default: `false`
-
-Use "smart" typograhic punctuation for things like quotes and dashes.
-
-### langPrefix
-
-Type: `String`
-Default: `lang-`
-
-Set the prefix for code block classes.
-
-### headerPrefix
-
-Type: `String`
-Default: ``
-
-Set the prefix for header IDs.
-
-## Access to lexer and parser
-
-You also have direct access to the lexer and parser if you so desire.
-
-``` js
-var tokens = marked.lexer(text, options);
-console.log(marked.parser(tokens));
+var editor = remark(document.body);
 ```
 
-``` js
-var lexer = new marked.Lexer(options);
-var tokens = lexer.lex(text);
-console.log(tokens);
-console.log(lexer.rules);
-```
+The React component is available as `remark/component`.
 
-## CLI
+```js
+var React = require('react');
+var Remark = require('remark/component');
 
-``` bash
-$ marked -o hello.html
-hello world
-^D
-$ cat hello.html
-<p>hello world</p>
+var editor = React.renderComponent(Remark(), document.getElementById('editor'));
 ```
 
-## Benchmarks
+## Browser Support
 
-node v0.4.x
+Tested in Chrome 35, Safari 6.1.1, and Firefox 29.
 
-``` bash
-$ node test --bench
-marked completed in 12071ms.
-showdown (reuse converter) completed in 27387ms.
-showdown (new converter) completed in 75617ms.
-markdown-js completed in 70069ms.
-```
+Internet Explorer 10 & 11 should also be supported but are untested currently.
 
-node v0.6.x
+## Screenshot
 
-``` bash
-$ node test --bench
-marked completed in 6448ms.
-marked (gfm) completed in 7357ms.
-marked (pedantic) completed in 6092ms.
-discount completed in 7314ms.
-showdown (reuse converter) completed in 16018ms.
-showdown (new converter) completed in 18234ms.
-markdown-js completed in 24270ms.
-```
+![Remark Screenshot](assets/screenshot.jpg)
 
-__Marked is now faster than Discount, which is written in C.__
-
-For those feeling skeptical: These benchmarks run the entire markdown test suite
-1000 times. The test suite tests every feature. It doesn't cater to specific
-aspects.
-
-node v0.8.x
-
-``` bash
-$ node test --bench
-marked completed in 3411ms.
-marked (gfm) completed in 3727ms.
-marked (pedantic) completed in 3201ms.
-robotskirt completed in 808ms.
-showdown (reuse converter) completed in 11954ms.
-showdown (new converter) completed in 17774ms.
-markdown-js completed in 17191ms.
-```
-
-## Another Javascript Markdown Parser
-
-The point of marked was to create a markdown compiler where it was possible to
-frequently parse huge chunks of markdown without having to worry about
-caching the compiled output somehow...or blocking for an unnecesarily long time.
-
-marked is very concise and still implements all markdown features. It is also
-now fully compatible with the client-side.
-
-marked more or less passes the official markdown test suite in its
-entirety. This is important because a surprising number of markdown compilers
-cannot pass more than a few tests. It was very difficult to get marked as
-compliant as it is. It could have cut corners in several areas for the sake
-of performance, but did not in order to be exactly what you expect in terms
-of a markdown rendering. In fact, this is why marked could be considered at a
-disadvantage in the benchmarks above.
-
-Along with implementing every markdown feature, marked also implements [GFM
-features][gfmf].
-
-``` bash
-$ node
-> require('marked').lexer('> i am using marked.')
-[ { type: 'blockquote_start' },
-  { type: 'paragraph',
-    text: 'i am using marked.' },
-  { type: 'blockquote_end' },
-  links: {} ]
-```
-
-## Running Tests & Contributing
-
-If you want to submit a pull request, make sure your changes pass the test
-suite. If you're adding a new feature, be sure to add your own test.
-
-The marked test suite is set up slightly strangely: `test/new` is for all tests
-that are not part of the original markdown.pl test suite (this is where your
-test should go if you make one). `test/original` is only for the original
-markdown.pl tests. `test/tests` houses both types of tests after they have been
-combined and moved/generated by running `node test --fix` or `marked --test
---fix`.
-
-In other words, if you have a test to add, add it to `test/new/` and then
-regenerate the tests with `node test --fix`. Commit the result. If your test
-uses a certain feature, for example, maybe it assumes GFM is *not* enabled, you
-can add `.nogfm` to the filename. So, `my-test.text` becomes
-`my-test.nogfm.text`. You can do this with any marked option. Say you want
-line breaks and smartypants enabled, your filename should be:
-`my-test.breaks.smartypants.text`.
-
-To run the tests:
-
-``` bash
-cd marked/
-node test
-```
-
-### Contribution and License Agreement
-
-If you contribute code to marked, you are implicitly allowing your code to be
-distributed under the MIT license. You are also implicitly verifying that all
-code is your original work. `</legalese>`
-
 ## License
 
-Copyright (c) 2011-2013, Christopher Jeffrey. (MIT License)
-
-See LICENSE for more info.
-
-[gfm]: https://help.github.com/articles/github-flavored-markdown
-[gfmf]: http://github.github.com/github-flavored-markdown/
-[pygmentize]: https://github.com/rvagg/node-pygmentize-bundled
-[highlight]: https://github.com/isagalaev/highlight.js
-[badge]: http://badge.fury.io/js/marked
-[tables]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-tables
-[breaks]: https://help.github.com/articles/github-flavored-markdown#newlines
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses eval() which is a dangerous function. This prevents the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2202846

increased by5321.59%

Number of package files

19

increased by90%

Lines of code

46311

increased by4577.88%

Number of low maintenance alerts

0

decreased by-100%

Worsened metrics

Dependency count

6

increased byInfinity%

Dev dependency count

6

increased by100%

Number of low quality alerts

3

increased by50%

Number of lines in readme file

58

decreased by-82.48%

Number of high supply chain risk alerts

1

increased byInfinity%

Number of low supply chain risk alerts

375

increased by37400%

Number of medium supply chain risk alerts

6

increased byInfinity%

Dependency changes

• + Addedenvify@^1.2.1

• + Addedfluxxor@^1.2.0

• + Addedinsert-css@^0.1.1

• + Addedlodash@git+ssh://[e-mail]:lodash/lodash#79829aec234e9a5deb04616dd228f710ac2b08f7

• + Addedmarked@^0.3.2

• + Addedreact@^0.10.0

• + Addedamdefine@1.0.1(transitive)

• + Addedbase62@0.1.1(transitive)

• + Addedenvify@1.2.1(transitive)

• + Addedesprima-fb@3001.1.0-dev-harmony-fb(transitive)

• + Addedeventemitter3@0.1.6(transitive)

• + Addedfluxxor@1.7.3(transitive)

• + Addedinsert-css@0.1.1(transitive)

• + Addedjstransform@3.0.0(transitive)

• + Addedlodash@3.10.1(transitive)

• + Addedmarked@0.3.19(transitive)

• + Addedobject-keys@0.4.0(transitive)

• + Addedobject-path@0.6.0(transitive)

• + Addedreact@0.10.0(transitive)

• + Addedsource-map@0.1.31(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedxtend@2.1.2(transitive)