package.json
8.0 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
{
"_args": [
[
{
"raw": "xmlcreate@^1.0.1",
"scope": null,
"escapedName": "xmlcreate",
"name": "xmlcreate",
"rawSpec": "^1.0.1",
"spec": ">=1.0.1 <2.0.0",
"type": "range"
},
"/Users/fzy/project/koa2_Sequelize_project/node_modules/js2xmlparser"
]
],
"_from": "xmlcreate@>=1.0.1 <2.0.0",
"_id": "xmlcreate@1.0.2",
"_inCache": true,
"_location": "/xmlcreate",
"_nodeVersion": "6.5.0",
"_npmOperationalInternal": {
"host": "packages-12-west.internal.npmjs.com",
"tmp": "tmp/xmlcreate-1.0.2.tgz_1488850911632_0.8478706304449588"
},
"_npmUser": {
"name": "michaelkourlas",
"email": "michael@kourlas.net"
},
"_npmVersion": "4.2.0",
"_phantomChildren": {},
"_requested": {
"raw": "xmlcreate@^1.0.1",
"scope": null,
"escapedName": "xmlcreate",
"name": "xmlcreate",
"rawSpec": "^1.0.1",
"spec": ">=1.0.1 <2.0.0",
"type": "range"
},
"_requiredBy": [
"/js2xmlparser"
],
"_resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-1.0.2.tgz",
"_shasum": "fa6bf762a60a413fb3dd8f4b03c5b269238d308f",
"_shrinkwrap": null,
"_spec": "xmlcreate@^1.0.1",
"_where": "/Users/fzy/project/koa2_Sequelize_project/node_modules/js2xmlparser",
"author": {
"name": "Michael Kourlas",
"email": "michael@kourlas.net"
},
"bugs": {
"url": "https://github.com/michaelkourlas/node-xmlcreate/issues"
},
"dependencies": {},
"description": "Simple XML builder for Node.js",
"devDependencies": {
"@types/chai": "^3.4.35",
"@types/mocha": "^2.2.39",
"chai": "^3.5.0",
"del": "^2.2.2",
"gulp": "^3.9.1",
"gulp-mocha": "^4.0.1",
"gulp-sourcemaps": "^2.4.1",
"gulp-tslint": "^7.1.0",
"gulp-typedoc": "^2.0.2",
"gulp-typescript": "^3.1.5",
"merge2": "^1.0.3",
"mocha": "^3.2.0",
"tslint": "^4.5.1",
"typedoc": "^0.5.7",
"typescript": "^2.2.1"
},
"directories": {},
"dist": {
"shasum": "fa6bf762a60a413fb3dd8f4b03c5b269238d308f",
"tarball": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-1.0.2.tgz"
},
"files": [
"lib",
"CHANGES.md",
"LICENSE.md",
"NOTICE.md",
"package.json",
"README.md"
],
"gitHead": "7633c9dc73db6f3ff473f50787168346906a0b50",
"homepage": "https://github.com/michaelkourlas/node-xmlcreate#readme",
"keywords": [
"build",
"builder",
"create",
"creator",
"xml"
],
"license": "Apache-2.0",
"main": "./lib/main.js",
"maintainers": [
{
"name": "michaelkourlas",
"email": "michael@kourlas.net"
}
],
"name": "xmlcreate",
"optionalDependencies": {},
"readme": "# xmlcreate #\r\n\r\n[](https://travis-ci.org/michaelkourlas/node-xmlcreate)\r\n[](https://badge.fury.io/js/xmlcreate)\r\n\r\n## Overview ##\r\n\r\nxmlcreate is a Node.js module that can be used to easily build XML using a\r\nsimple API.\r\n\r\n## Features ##\r\n\r\nxmlcreate uses a DOM-style API to build XML. Each construct in XML, including\r\nelements, attributes, and even the document itself, is represented as a node\r\nin a tree with a document node at the root.\r\n\r\nEach node has a set of properties corresponding to the node's properties in\r\nXML. For example, the element node has a name property, while the CDATA node\r\nhas a character data property.\r\n\r\nEach node also has a set of children corresponding to the node's value,\r\nchildren or attributes in XML, depending on the context. For example, the XML\r\ndeclaration and document type declaration are represented as child nodes of the\r\nroot document node, while sub-elements and element attributes are represented\r\nas child nodes of element nodes.\r\n\r\nxmlcreate performs some basic validation during tree building to ensure that\r\nthe resulting XML is well-formed. Nodes can only have certain types or\r\nquantities of nodes as children, while node properties are checked to ensure\r\nthat they do not contain characters disallowed in XML for that node or in\r\ngeneral.\r\n\r\nHowever, xmlcreate does not perform comprehensive validation. For example, it\r\ndoes not match the tree structure against a schema or confirm that entity\r\nreferences are valid. You should use a XML parser for this purpose instead.\r\n\r\nOnce the tree is built, the tree itself or any of its subtrees can be\r\nserialized to text. The formatting of the text is customizable.\r\n\r\n## Installation ##\r\n\r\nThe easiest way to install xmlcreate is using npm:\r\n\r\n```\r\nnpm install xmlcreate\r\n```\r\n\r\nYou can also build xmlcreate from source using npm, gulp, and typings: \r\n\r\n```\r\ngit clone https://github.com/michaelkourlas/node-xmlcreate.git\r\nnpm install\r\ngulp\r\n```\r\n\r\nYou'll need to install gulp first if you don't have it:\r\n\r\n```\r\nnpm install -g gulp\r\n```\r\n\r\nYou can then copy the folder into your node_modules directory.\r\n\r\nThe `default` target will build the production variant of xmlcreate, run all\r\ntests, and build the documentation.\r\n\r\nYou can build the production variant without running tests using the target\r\n`prod`. You can also build the development version using the target `dev`. At\r\nthe moment, the only difference between the two is that the development version\r\nincludes source maps.\r\n\r\n## Usage ##\r\n\r\nThe documentation for the current version is available [here](http://www.kourlas.com/node-xmlcreate/docs/1.0.2/).\r\n\r\nYou can also build the documentation using gulp:\r\n\r\n```\r\ngulp docs\r\n```\r\n\r\n## Examples ##\r\n\r\nThe following example illustrates the basic usage of xmlcreate:\r\n\r\n```javascript\r\nvar xmlcreate = require(\"xmlcreate\");\r\n\r\nvar document = xmlcreate.document(\"html\");\r\ndocument\r\n .decl({encoding: \"UTF-8\"})\r\n .up()\r\n .dtd(\"html\", \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\",\r\n \"-//W3C//DTD XHTML 1.0 Strict//EN\")\r\n .up()\r\n .root()\r\n .attribute(\"xmlns\", \"http://www.w3.org/1999/xhtml\")\r\n .up()\r\n .attribute(\"xml:lang\", \"en\")\r\n .up()\r\n .attribute(\"lang\", \"en\")\r\n .up()\r\n .element(\"head\")\r\n .element(\"title\")\r\n .charData(\"My page title\")\r\n .up()\r\n .up()\r\n .up()\r\n .element(\"body\")\r\n .element(\"h1\")\r\n .charData(\"Welcome!\")\r\n .up()\r\n .up()\r\n .element(\"p\")\r\n .charData(\"This is some text on my website.\");\r\n\r\nconsole.log(document.toString({doubleQuotes: true}));\r\n```\r\n\r\nThis example produces the following XML:\r\n\r\n```xml\r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\r\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\r\n <head>\r\n <title>My page title</title>\r\n </head>\r\n <body>\r\n <h1>Welcome!</h1>\r\n <p>This is some text on my website.</p>\r\n </body>\r\n</html>\r\n```\r\n\r\nAdditional examples can be found in examples/example.js.\r\n\r\n## Tests ##\r\n\r\nxmlcreate includes a set of tests to verify core functionality. You can run\r\nthe tests using gulp:\r\n\r\n```\r\ngulp test\r\n```\r\n\r\nThe `test` target builds the production variant of xmlcreate before running\r\nthe tests. The `test-prod` target does the same thing, while the `test-dev`\r\ntarget builds the development variant first instead.\r\n\r\n## License ##\r\n\r\nxmlcreate is licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). \r\nPlease see the LICENSE.md file for more information.\r\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git://github.com/michaelkourlas/node-xmlcreate.git"
},
"scripts": {},
"typings": "./lib/main",
"version": "1.0.2"
}