JS Source Extractor
An extractor of source code from Javascript libraries containing source maps with embedded or referenced source.
Install for CLI use
$ npm install -g js-source-extractor
Example CLI use
$ cd /tmp$ js-source-extractor https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.jsLoading resource https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js to examine Resource will be treated as a JavascriptReading contents of https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.jssource map response completeFound source map urlExtracting embedded source mapSource map references 1 source filesSource /tmp/extract/src/embedded-sourcemap-test.ts written
To extract files to a specific folder, use --outDir
like:
$ js-source-extractor https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js --outDir /tmp/extractLoading resource https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js to examine Resource will be treated as a JavascriptReading contents of https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.jssource map response completeFound source map urlExtracting embedded source mapSource map references 1 source filesSource /tmp/extract/src/embedded-sourcemap-test.ts written
If you have a source map on your file system already, use file://
protocol like:
$ cd /tmp$ wget https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js$ js-source-extractor file:///tmp/embedded-sourcemap-test.js Loading resource file:///tmp/embedded-sourcemap-test.js to examine Resource will be treated as a Javascript Reading contents of file:///tmp/embedded-sourcemap-test.js Found source map url Extracting embedded source map Source map references 1 source files Source /tmp/extract/src/embedded-sourcemap-test.ts written
Help output from the CLI
$ js-source-extractor.js --help Usage: js-source-extractor [options] <resourceUrl> Extracts source from javascript frameworks with sourcemap information Options: -v, --version output the version number -o, --outDir <outDir> Base output directory where source files should be output to -i, --include <includePattern> Include pattern to apply when selecting source files
Install as node module to use in your own project
$ npm install --save-dev js-source-extractor
To extract source code from a sourcemap embedded in a javascript and call a callback per source file, use:
; extractSrcnew URL'https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js', null,;
To extract code from a sourcemap embedded in a javascript and write the source files to the disk, use:
;; ; // directory to store source files inawait extractSrcToDirnew URL'https://raw.githubusercontent.com/unblu/js-source-extractor/master/resources/embedded-sourcemap-test.js', outDir;
Running the tests
JS Source Extractor features a number of mocha tests to verify the various API functionalities.
To start the tests, use:
$ npm test
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Authors
- Kay Huber - Initial work - unblu inc.
See also the list of contributors who participated in this project.
License
This project is licensed under the ISC License
Copyright (c) 2018, Kay Huber, unblu inc.
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Acknowledgments
- Thanks Dave for your encouragement to create this tiny tool