-
Notifications
You must be signed in to change notification settings - Fork 465
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
tools: add tool to check for N-API modules #346
Closed
+133
−0
Closed
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev
Previous commit
squash! add doc and address nits
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Checker Tool | ||
|
||
**node-addon-api** provides a [checker tool][] that will inspect a given | ||
directory tree, identifying all Node.js native addons therein, and further | ||
indicating for each addon whether it is an N-API addon. | ||
|
||
## To use the checker tool: | ||
|
||
1. Install the application with `npm install`. | ||
|
||
2. If the application does not depend on **node-addon-api**, copy the | ||
checker tool into the application's directory. | ||
|
||
3. If the application does not depend on **node-addon-api**, run the checker | ||
tool from the application's directory: | ||
|
||
```sh | ||
node ./check-napi.js | ||
``` | ||
|
||
Otherwise, the checker tool can be run from the application's | ||
`node_modules/` subdirectory: | ||
```sh | ||
node ./node_modules/node-addon-api/tools/check-napi.js | ||
``` | ||
The tool accepts the root directory from which to start checking for Node.js | ||
native addons as a single optional command line parameter. If ommitted it will | ||
start checking from the current directory (`.`). | ||
[checker tool]: ../tools/check-napi.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
'use strict'; | ||
// Descend into a directory structure and, for each file matching *.node, output | ||
// based on the imports found in the file whether it's an N-API module or not. | ||
|
||
|
@@ -7,8 +8,8 @@ const child_process = require('child_process'); | |
|
||
// Read the output of the command, break it into lines, and use the reducer to | ||
// decide whether the file is an N-API module or not. | ||
function checkFile(file, command, arguments, reducer) { | ||
const child = child_process.spawn(command, arguments, { | ||
function checkFile(file, command, argv, reducer) { | ||
const child = child_process.spawn(command, argv, { | ||
stdio: ['inherit', 'pipe', 'inherit'] | ||
}); | ||
let leftover = ''; | ||
|
@@ -28,64 +29,67 @@ function checkFile(file, command, arguments, reducer) { | |
console.log( | ||
command + ' exited with code: ' + code + ' and signal: ' + signal); | ||
} else { | ||
// Green if it's a N-API module, red otherwise. | ||
console.log( | ||
'\033[' + (isNapi ? '42' : '41') + 'm' + | ||
'\x1b[' + (isNapi ? '42' : '41') + 'm' + | ||
(isNapi ? ' N-API' : 'Not N-API') + | ||
'\033[0m: ' + file); | ||
'\x1b[0m: ' + file); | ||
} | ||
}); | ||
} | ||
|
||
// Use nm -a to list symbols. | ||
function checkFileUNIX(file) { | ||
checkFile(file, 'nm', ['-a', file], (soFar, line) => { | ||
if (soFar === undefined) { | ||
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/); | ||
if (line[2] === 'U') { | ||
if (/^napi/.test(line[3])) { | ||
soFar = true; | ||
} | ||
if (soFar === undefined) { | ||
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/); | ||
if (line[2] === 'U') { | ||
if (/^napi/.test(line[3])) { | ||
soFar = true; | ||
} | ||
} | ||
return soFar; | ||
} | ||
return soFar; | ||
}); | ||
} | ||
|
||
// Use dumpbin /imports to list symbols. | ||
function checkFileWin32(file) { | ||
checkFile(file, 'dumpbin', ['/imports', file], (soFar, line) => { | ||
if (soFar === undefined) { | ||
line = line.match(/([0-9a-f]*)? +([a-zA-Z0-9]) (.*$)/); | ||
if (line && /^napi/.test(line[line.length - 1])) { | ||
soFar = true; | ||
} | ||
if (soFar === undefined) { | ||
line = line.match(/([0-9a-f]*)? +([a-zA-Z0-9]) (.*$)/); | ||
if (line && /^napi/.test(line[line.length - 1])) { | ||
soFar = true; | ||
} | ||
return soFar; | ||
} | ||
return soFar; | ||
}); | ||
} | ||
|
||
// Descend into a directory structure and pass each file ending in '.node' to | ||
// one of the above checks, depending on the OS. | ||
function recurse(top) { | ||
fs.readdir(top, (error, items) => { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: This error is ignored. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed. |
||
if (error) { | ||
throw ("error reading directory " + top + ": " + error); | ||
} | ||
items.forEach((item) => { | ||
item = path.join(top, item); | ||
fs.stat(item, ((item) => (error, stats) => { | ||
if (!error) { | ||
if (stats.isDirectory()) { | ||
recurse(item); | ||
} else if (/[.]node$/.test(item) && | ||
// Explicitly ignore files called 'nothing.node' because they are | ||
// artefacts of node-addon-api having identified a version of | ||
// Node.js that ships with a correct implementation of N-API. | ||
path.basename(item) !== 'nothing.node') { | ||
process.platform === 'win32' ? | ||
checkFileWin32(item) : | ||
checkFileUNIX(item); | ||
} | ||
} else { | ||
if (error) { | ||
throw ("error about " + item + ": " + error); | ||
} | ||
if (stats.isDirectory()) { | ||
recurse(item); | ||
} else if (/[.]node$/.test(item) && | ||
// Explicitly ignore files called 'nothing.node' because they are | ||
// artefacts of node-addon-api having identified a version of | ||
// Node.js that ships with a correct implementation of N-API. | ||
path.basename(item) !== 'nothing.node') { | ||
process.platform === 'win32' ? | ||
checkFileWin32(item) : | ||
checkFileUNIX(item); | ||
} | ||
})(item)); | ||
}); | ||
}); | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Generally strict mode is preferred.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thefourtheye fixed, and a good thing too, because it had implications for the rest of the code. Thanks!