UNPKG

canonical

Version:

Canonical code style linter and formatter for JavaScript, SCSS and CSS.

github.com/gajus/canonical

gajus/canonical

63 lines (62 loc) • 3.75 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
{ "_args": [ [ "generate-function@https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "/Users/gajus/Documents/dev/canonical-code-style/canonical" ] ], "_from": "generate-function@>=2.0.0 <3.0.0", "_id": "generate-function@2.0.0", "_inCache": true, "_location": "/generate-function", "_phantomChildren": {}, "_requested": { "name": "generate-function", "raw": "generate-function@https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "rawSpec": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "scope": null, "spec": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "type": "remote" }, "_requiredBy": [ "/is-my-json-valid" ], "_resolved": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "_shasum": "6858fe7c0969b7d4e9093337647ac79f60dfbe74", "_shrinkwrap": null, "_spec": "generate-function@https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", "_where": "/Users/gajus/Documents/dev/canonical-code-style/canonical", "author": { "name": "Mathias Buus" }, "bugs": { "url": "https://github.com/mafintosh/generate-function/issues" }, "dependencies": {}, "description": "Module that helps you write generated functions in Node", "devDependencies": { "tape": "^2.13.4" }, "homepage": "https://github.com/mafintosh/generate-function", "keywords": [ "code", "function", "generate", "generation", "performance" ], "license": "MIT", "main": "index.js", "name": "generate-function", "optionalDependencies": {}, "readme": "# generate-function\n\nModule that helps you write generated functions in Node\n\n```\nnpm install generate-function\n```\n\n[![build status](http://img.shields.io/travis/mafintosh/generate-function.svg?style=flat)](http://travis-ci.org/mafintosh/generate-function)\n\n## Disclamer\n\nWriting code that generates code is hard.\nYou should only use this if you really, really, really need this for performance reasons (like schema validators / parsers etc).\n\n## Usage\n\n``` js\nvar genfun = require('generate-function')\n\nvar addNumber = function(val) {\n var fn = genfun()\n ('function add(n) {')\n ('return n + %d', val) // supports format strings to insert values\n ('}')\n\n return fn.toFunction() // will compile the function\n}\n\nvar add2 = addNumber(2)\n\nconsole.log('1+2=', add2(1))\nconsole.log(add2.toString()) // prints the generated function\n```\n\nIf you need to close over variables in your generated function pass them to `toFunction(scope)`\n\n``` js\nvar multiply = function(a, b) {\n return a * b\n}\n\nvar addAndMultiplyNumber = function(val) {\n var fn = genfun()\n ('function(n) {')\n ('if (typeof n !== \"number\") {') // ending a line with { will indent the source\n ('throw new Error(\"argument should be a number\")')\n ('}')\n ('var result = multiply(%d, n+%d)', val, val)\n ('return result')\n ('}')\n\n // use fn.toString() if you want to see the generated source\n\n return fn.toFunction({\n multiply: multiply\n })\n}\n\nvar addAndMultiply2 = addAndMultiplyNumber(2)\n\nconsole.log('(3 + 2) * 2 =', addAndMultiply2(3))\n```\n\n## Related\n\nSee [generate-object-property](https://github.com/mafintosh/generate-object-property) if you need to safely generate code that\ncan be used to reference an object property\n\n## License\n\nMIT", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/mafintosh/generate-function.git" }, "scripts": { "test": "tape test.js" }, "version": "2.0.0" }