diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..41576b4 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,97 @@ +{ + "projectName": "node-graphviz", + "projectOwner": "glejeune", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "glejeune", + "name": "Gregoire Lejeune", + "avatar_url": "https://avatars1.githubusercontent.com/u/15168?v=4", + "profile": "http://lejeun.es", + "contributions": [ + "code", + "doc", + "example" + ] + }, + { + "login": "dariusk", + "name": "Darius Kazemi", + "avatar_url": "https://avatars3.githubusercontent.com/u/266454?v=4", + "profile": "https://tinysubversions.com", + "contributions": [ + "code" + ] + }, + { + "login": "SebastienElet", + "name": "Sébastien ELET", + "avatar_url": "https://avatars0.githubusercontent.com/u/541937?v=4", + "profile": "https://github.com/SebastienElet", + "contributions": [ + "code" + ] + }, + { + "login": "papandreou", + "name": "Andreas Lind", + "avatar_url": "https://avatars3.githubusercontent.com/u/373545?v=4", + "profile": "https://github.com/papandreou", + "contributions": [ + "code" + ] + }, + { + "login": "blakmatrix", + "name": "Farrin Reid", + "avatar_url": "https://avatars3.githubusercontent.com/u/91209?v=4", + "profile": "http://www.blakmatrix.com", + "contributions": [ + "code" + ] + }, + { + "login": "pahen", + "name": "Patrik Henningsson", + "avatar_url": "https://avatars3.githubusercontent.com/u/353888?v=4", + "profile": "https://pahen.se", + "contributions": [ + "code" + ] + }, + { + "login": "pooriaazimi", + "name": "Pooria Azimi", + "avatar_url": "https://avatars2.githubusercontent.com/u/814637?v=4", + "profile": "https://github.com/pooriaazimi", + "contributions": [ + "code" + ] + }, + { + "login": "BridgeAR", + "name": "Ruben Bridgewater", + "avatar_url": "https://avatars2.githubusercontent.com/u/8822573?v=4", + "profile": "https://twitter.com/BridgeAR", + "contributions": [ + "code" + ] + }, + { + "login": "mathieuravaux", + "name": "Mathieu Ravaux", + "avatar_url": "https://avatars1.githubusercontent.com/u/38495?v=4", + "profile": "https://github.com/mathieuravaux", + "contributions": [ + "code" + ] + } + ], + "contributorsPerLine": 7 +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4ad4a98 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,65 @@ +# Change Log + +## [0.0.9](https://github.com/glejeune/node-graphviz/tree/0.0.9) (2019-04-03) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.8...0.0.9) + +**Closed issues:** + +- Is it possible to create a stripped down version for browsers that only generates dot code? [\#15](https://github.com/glejeune/node-graphviz/issues/15) +- Is there a way to tell this library to ignore duplicate edges? [\#13](https://github.com/glejeune/node-graphviz/issues/13) +- How to get x,y coords for a node? [\#11](https://github.com/glejeune/node-graphviz/issues/11) + +**Merged pull requests:** + +- Fix missing error handling [\#26](https://github.com/glejeune/node-graphviz/pull/26) ([BridgeAR](https://github.com/BridgeAR)) +- Fixing `for in` loops [\#17](https://github.com/glejeune/node-graphviz/pull/17) ([dariusk](https://github.com/dariusk)) +- Node setter is now fluent. [\#16](https://github.com/glejeune/node-graphviz/pull/16) ([SebastienElet](https://github.com/SebastienElet)) + +## [0.0.8](https://github.com/glejeune/node-graphviz/tree/0.0.8) (2012-08-04) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.7...0.0.8) + +**Closed issues:** + +- Clickable Nodes [\#10](https://github.com/glejeune/node-graphviz/issues/10) + +**Merged pull requests:** + +- `npm install node-graphviz` --\> `npm install graphviz` [\#9](https://github.com/glejeune/node-graphviz/pull/9) ([pooriaazimi](https://github.com/pooriaazimi)) + +## [0.0.7](https://github.com/glejeune/node-graphviz/tree/0.0.7) (2012-07-01) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.6...0.0.7) + +**Closed issues:** + +- Publish 0.0.6 with correct dependency on 'temp' to the npm repo? [\#5](https://github.com/glejeune/node-graphviz/issues/5) + +**Merged pull requests:** + +- Fixed so it can be installed on v0.8. Please bump version & update the NPM repo :\) [\#7](https://github.com/glejeune/node-graphviz/pull/7) ([pahen](https://github.com/pahen)) +- Hi! I fixed some calls to "sys" for you! [\#6](https://github.com/glejeune/node-graphviz/pull/6) ([node-migrator-bot](https://github.com/node-migrator-bot)) + +## [0.0.6](https://github.com/glejeune/node-graphviz/tree/0.0.6) (2012-01-27) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.5...0.0.6) + +**Closed issues:** + +- Error: EPIPE, Broken pipe [\#3](https://github.com/glejeune/node-graphviz/issues/3) +- Graph.prototype.getNodeAttribut [\#2](https://github.com/glejeune/node-graphviz/issues/2) + +## [0.0.5](https://github.com/glejeune/node-graphviz/tree/0.0.5) (2011-12-14) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.4...0.0.5) + +**Merged pull requests:** + +- graphviz.js: Don't require the 'sys' module. [\#4](https://github.com/glejeune/node-graphviz/pull/4) ([papandreou](https://github.com/papandreou)) + +## [0.0.4](https://github.com/glejeune/node-graphviz/tree/0.0.4) (2010-11-16) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.3...0.0.4) + +## [0.0.3](https://github.com/glejeune/node-graphviz/tree/0.0.3) (2010-10-04) +[Full Changelog](https://github.com/glejeune/node-graphviz/compare/0.0.2...0.0.3) + +## [0.0.2](https://github.com/glejeune/node-graphviz/tree/0.0.2) (2010-09-29) + + +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..15307f2 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# Node.js GraphViz Module + +[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors) + +Copyright (C) 2010-2019 Gregoire Lejeune + +* Sources : http://github.com/glejeune/node-graphviz + +## DESCRIPTION + +Interface to the GraphViz graphing tool + +## SYNOPSIS + +A basic example + +``` +var util = require('util'), + graphviz = require('graphviz'); + +// Create digraph G +var g = graphviz.digraph("G"); + +// Add node (ID: Hello) +var n1 = g.addNode( "Hello", {"color" : "blue"} ); +n1.set( "style", "filled" ); + +// Add node (ID: World) +g.addNode( "World" ); + +// Add edge between the two nodes +var e = g.addEdge( n1, "World" ); +e.set( "color", "red" ); + +// Print the dot script +console.log( g.to_dot() ); + +// Set GraphViz path (if not in your path) +g.setGraphVizPath( "/usr/local/bin" ); +// Generate a PNG output +g.output( "png", "test01.png" ); +``` + +## INSTALLATION + +``` +$ npm install graphviz +``` + +You also need to install GraphViz[http://www.graphviz.org] + +## DOCUMENTATION + +Install node-jake[http://github.com/mde/node-jake] and dox[http://github.com/visionmedia/dox] then run + +``` +jake doc && open documentation.html +``` + +## AUTHORS + +* Gregoire Lejeune (http://algorithmique.net) +* Mathieu Ravaux (http://mathieuravaux.com) + +## LICENCES + +Copyright (c) 2010 Gregoire Lejeune + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +## Contributors + +Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): + + + +
Gregoire Lejeune
Gregoire Lejeune
💻 📖 💡		Darius Kazemi
Darius Kazemi
💻		Sébastien ELET
Sébastien ELET
💻		Andreas Lind
Andreas Lind
💻		Farrin Reid
Farrin Reid
💻		Patrik Henningsson
Patrik Henningsson
💻		Pooria Azimi
Pooria Azimi
💻
Ruben Bridgewater
Ruben Bridgewater
💻		Mathieu Ravaux
Mathieu Ravaux
💻
+ + + +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 41e07f4..0000000 --- a/README.rdoc +++ /dev/null @@ -1,122 +0,0 @@ -= Node.js GraphViz Module - -Copyright (C) 2010 Gregoire Lejeune - -* Sources : http://github.com/glejeune/node-graphviz - -== DESCRIPTION - -Interface to the GraphViz graphing tool - -== TODO - -* So many things! - -== CHANGELOG - -=== 0.0.8 : -* Issue #10 : Update graphviz attributs - -=== 0.0.7 : -* Issue #6 : fixed some calls to "sys" -* Issue #7 : Fixed so it can be installed on v0.8 (by Patrik Henningsson ) - -=== 0.0.6 : -* Tiny corrections - -=== 0.0.5 : -* graphviz.js: Don't require the 'sys' module. - -=== 0.0.4 : -* Major correction in render : error callback now take three arguments : code, stdout, stderr -* Major correction in parse : error callback now take three arguments : code, stdout, stderr -* Major bugs corrections -* Update Attributs class -* parse now accept a file or a script -* Update render (see tests/hello.js) -* Add graph.from and node.to (see tests/compound.js) - -=== 0.0.3 : - -* Add attributs to addNode and addEdge -* Add parser (see tests/parse.js) - -=== 0.0.2 : -* Added the ability to render in-memory (without writing to the filesystem) (By Mathieu Ravaux) -* Rewrite output method - -=== 0.0.1 : -* Initial version - -== SYNOPSIS - -A basic example - - var util = require('util'), - graphviz = require('graphviz'); - - // Create digraph G - var g = graphviz.digraph("G"); - - // Add node (ID: Hello) - var n1 = g.addNode( "Hello", {"color" : "blue"} ); - n1.set( "style", "filled" ); - - // Add node (ID: World) - g.addNode( "World" ); - - // Add edge between the two nodes - var e = g.addEdge( n1, "World" ); - e.set( "color", "red" ); - - // Print the dot script - console.log( g.to_dot() ); - - // Set GraphViz path (if not in your path) - g.setGraphVizPath( "/usr/local/bin" ); - // Generate a PNG output - g.output( "png", "test01.png" ); - -== INSTALLATION - - $ cd ~/.node_libraries - $ git clone git://github.com/glejeune/node-graphviz.git - -Or : - - $ npm install graphviz - -You also need to install GraphViz[http://www.graphviz.org] - -== DOCUMENTATION - -Install node-jake[http://github.com/mde/node-jake] and dox[http://github.com/visionmedia/dox] then run - - jake doc && open documentation.html - -== AUTHORS - -* Gregoire Lejeune (http://algorithmique.net) -* Mathieu Ravaux (http://mathieuravaux.com) - -== LICENCES - -Copyright (c) 2010 Gregoire Lejeune - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..9ab6f95 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,13 @@ +{ + "name": "graphviz", + "version": "0.0.8", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "temp": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/temp/-/temp-0.4.0.tgz", + "integrity": "sha1-ZxrWPVe+D+nXKUZks/xABjZnimA=" + } + } +} diff --git a/package.json b/package.json index ad70a3c..9190c3d 100644 --- a/package.json +++ b/package.json @@ -1,25 +1,28 @@ { - "name" : "graphviz", - "version" : "0.0.8", - "author": "Gregoire Lejeune (http://algorithmique.net/)", - "description" : "Node.js interface to the GraphViz graphing tool", - "homepage" : "http://algorithmique.net/", - "contributors" : [ - "Gregoire Lejeune (http://algorithmique.net)", - "Mathieu Ravaux (http://mathieuravaux.com)" - ], - "repository" : { - "type" : "git", - "url" : "http://github.com/glejeune/node-graphviz.git" - }, - "keywords" : ["graphviz", "dot"], - "directories" : { "lib" : "./lib" }, - "main" : "lib/graphviz", - "engines": { - "node": ">=0.6.8" - }, - "dependencies": { - "temp": "~0.4.0" - }, - "devDependencies": {} + "name": "graphviz", + "version": "0.0.9", + "author": "Gregoire Lejeune (http://algorithmique.net/)", + "description": "Node.js interface to the GraphViz graphing tool", + "homepage": "http://algorithmique.net/", + "license": "GPL-3.0", + "contributors": [ + "Gregoire Lejeune (http://algorithmique.net)", + "Mathieu Ravaux (http://mathieuravaux.com)" + ], + "repository": { + "type": "git", + "url": "http://github.com/glejeune/node-graphviz.git" + }, + "keywords": ["graphviz", "dot"], + "directories": { + "lib": "./lib" + }, + "main": "lib/graphviz", + "engines": { + "node": ">=0.6.8" + }, + "dependencies": { + "temp": "~0.4.0" + }, + "devDependencies": {} }