proto-cli - npm Package Compare versions
Comparing version 0.0.8 to 0.0.9
@@ -23,3 +23,3 @@ (function() { | ||
| VIEWER_URL = 'http://proto-cli.herokuapp.com/'; | ||
| VIEWER_URL = 'http://proto.es/'; | ||
@@ -26,0 +26,0 @@ PROTO_FILES = ['script.coffee', 'markup.jade', 'style.styl', 'settings.json', 'notes.md']; |
@@ -61,3 +61,3 @@ (function() { | ||
| var page; | ||
| page = "<!-- Generated by https://github.com/droptype/proto v" + VERSION + " -->\n<!doctype html>\n<html>\n<head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>\n " + compiled.script_libraries + "\n " + compiled.style_libraries + "\n " + compiled.extra_head_markup + "\n <style>\n " + compiled.style + "\n </style>\n</head>\n<body>\n " + compiled.markup + "\n <script>\n " + compiled.script + "\n </script>\n</body>\n</html>"; | ||
| page = "<!-- Generated by https://github.com/droptype/proto v" + VERSION + " -->\n<!doctype html>\n<html>\n<head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>\n " + compiled.script_libraries + "\n " + compiled.style_libraries + "\n " + compiled.extra_head_markup + "\n <style>\n " + compiled.style + "\n </style>\n</head>\n<body>\n " + compiled.markup + "\n <script>\n " + compiled.script + "\n </script>\n " + compiled.extra_body_markup + "\n</body>\n</html>"; | ||
| return page; | ||
@@ -74,3 +74,4 @@ }; | ||
| style_libraries: compileStyleLibraries(sources.settings.style_libraries), | ||
| extra_head_markup: compileExtraHeadMarkup(sources.settings.extra_head_markup) | ||
| extra_head_markup: compileExtraHeadMarkup(sources.settings.extra_head_markup), | ||
| extra_body_markup: sources.extra_body || '' | ||
| }); | ||
@@ -77,0 +78,0 @@ return output; |
| (function() { | ||
| module.exports = '0.0.8'; | ||
| module.exports = '0.0.9'; | ||
| }).call(this); |
| { | ||
| "name": "proto-cli", | ||
| "version": "0.0.8", | ||
| "version": "0.0.9", | ||
| "description": "A front-end web prototyping tool, combining markup, style, and script into a served, rendered page.", | ||
@@ -5,0 +5,0 @@ "main": "bin/proto", |
| # Proto | ||
| *v0.0.8* | ||
| *v1.0.0* | ||
| [Proto](https://github.com/droptype/proto) is a front-end web prototyping tool, combining markup ([Jade](http://jade-lang.com/)), script ([CoffeeScript](http://coffeescript.org)), and style ([Stylus](http://learnboost.github.com/stylus/)) into a single page. It creates a set of files each representing one of those three facets of the page, plus files for notes and settings, and serves up their rendered form. Every time the page is loaded, those files are compiled on-the-fly. It's helpful for creating prototypes using CoffeeScript, Jade, and Stylus, without having to set up a build process and environment. | ||
| See [this Marquee post](http://marquee.by/alecperkins/proto/) for an explanation of the motivation, as well as a walkthrough. | ||
| * [Repository](https://github.com/droptype/proto) | ||
| * [Issues](https://github.com/droptype/proto/issues) | ||
| * [Example Proto project as Gist](https://gist.github.com/3894924) | ||
| * [Motivation & walkthrough](http://marquee.by/alecperkins/proto/) | ||
| [Example Proto project as Gist](https://gist.github.com/3894924) | ||
| ## Installation | ||
@@ -15,12 +18,13 @@ | ||
| npm install -g proto-cli | ||
| $ npm install -g proto-cli | ||
| or from source | ||
| git clone git://github.com/droptype/proto.git | ||
| cd proto | ||
| cake build | ||
| npm install -g . | ||
| $ git clone git://github.com/droptype/proto.git | ||
| $ cd proto | ||
| $ mkdir lib | ||
| $ cake build | ||
| $ npm install -g . | ||
| `cake build` will compile `src/proto.coffee` into `lib/proto.js` (ignored by git). | ||
| `cake build` will compile `src/*.coffee` into `lib/*.js` (ignored by git). | ||
@@ -30,2 +34,3 @@ Proto needs to be installed globally using `-g` so it can create the necessary command in `/usr/local/bin`. | ||
| ## Usage | ||
@@ -35,8 +40,8 @@ | ||
| proto -i <project_name> | ||
| proto -ig <gist_id_or_url> [<project_name>] | ||
| $ proto -i <project_name> | ||
| $ proto -ig <gist_id_or_url> [<project_name>] | ||
| Initializes the project by creating a folder with the specified name and adding five files: `markup.jade`, `script.coffee`, `style.styl`, `settings.json`, and `notes.md`. | ||
| e.g. `proto -i my_project` creates a folder called `my_project` in the current working directory | ||
| e.g. `$ proto -i my_project` creates a folder called `my_project` in the current working directory | ||
@@ -57,7 +62,7 @@ my_project/ | ||
| proto <project_name> | ||
| $ proto <project_name> | ||
| Or specify a port: | ||
| proto <project_name> -p 8080 | ||
| $ proto <project_name> -p 8080 | ||
@@ -75,4 +80,4 @@ This starts a server that serves the compiled markup, script, and style on the specified port (default 5000). The source files are compiled every time the page is requested. | ||
| proto -g <project_name> | ||
| proto -g <project_name> --public | ||
| $ proto -g <project_name> | ||
| $ proto -g <project_name> --public | ||
@@ -85,4 +90,4 @@ This will upload the five files in the specified project folder to an anonymous Gist. By default, the Gist is private. Adding the `--public` flag will make it a public Gist. But, anonymous Gists aren't terribly useful besides one-off sharing, so *Authenticated* Gists are recommended. | ||
| proto --github <username> <password> | ||
| proto --github <username> "<password with spaces>" | ||
| $ proto --github <username> <password> | ||
| $ proto --github <username> "<password with spaces>" | ||
@@ -95,3 +100,14 @@ This will use the GitHub API to [generate an access token](http://developer.github.com/v3/oauth/#create-a-new-authorization) that is stored in `~/.proto-cli`. Your username and password are *never* stored. | ||
| ### Viewer | ||
| Proto includes a web viewer running at [proto.es](http://proto.es), which will render the specified Gist the same as the command-line would. It allows for easy sharing of the rendered Proto project, even specific versions of it (since it's just a git repo). | ||
| Example with the [sample project](https://gist.github.com/3894924): [proto.es/3894924](http://proto.es/3894924) ([older version](http://proto.es/3894924/e7496f08d10dce02db7209473912a1aa0676ce13)) | ||
| The viewer is running on Heroku, with an alternate url that also works: [proto-cli.herokuapp.com](http://proto-cli.herokuapp.com). You can run your own viewer if you like. It's a Node-based web app located in [viewer/app.coffee](https://github.com/droptype/proto/blob/master/viewer/app.coffee). | ||
| Note: [Droptype](http://github.com/droptype) does have analytics code on the viewer, so we can monitor usage and make improvements. But, this code is only added to the page if the Gist is public, and only tracks from the `proto.es` and `proto-cli.herokuapp.com` domains. See exactly what it does in the [source](https://github.com/droptype/proto/blob/master/viewer/app.coffee). | ||
| ## FAQ | ||
@@ -108,2 +124,9 @@ | ||
| ## Authors | ||
| * [Alec Perkins](http://github.com/alecperkins), [Droptype Inc](http://droptype.com) | ||
| ## License | ||
@@ -113,1 +136,2 @@ | ||
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Non-existent author
Supply chain riskThe package was published by an npm account that no longer exists.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.01%
43836
- Number of package files
- increased by6.25%
17
- Lines of code
- increased by0.23%
440
- Number of lines in readme file
- increased by22.86%
129
Worsened metrics
- Number of high supply chain risk alerts
- increased byInfinity%
1