Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paazmaya/shuji
Reverse engineering JavaScript and CSS sources from sourcemaps
https://github.com/paazmaya/shuji
hacktoberfest nodejs sourcemaps
Last synced: 7 days ago
JSON representation
Reverse engineering JavaScript and CSS sources from sourcemaps
- Host: GitHub
- URL: https://github.com/paazmaya/shuji
- Owner: paazmaya
- License: mit
- Created: 2016-02-11T21:34:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T17:39:02.000Z (11 days ago)
- Last Synced: 2024-10-25T06:55:04.840Z (10 days ago)
- Topics: hacktoberfest, nodejs, sourcemaps
- Language: JavaScript
- Homepage:
- Size: 651 KB
- Stars: 973
- Watchers: 21
- Forks: 173
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - paazmaya/shuji - Reverse engineering JavaScript and CSS sources from sourcemaps (JavaScript)
README
# shuji (周氏)
> Reverse engineering JavaScript and CSS sources from sourcemaps
[](https://app.travis-ci.com/paazmaya/shuji)
[](https://ci.appveyor.com/project/paazmaya/shuji/branch/master)
[](https://github.com/paazmaya/shuji/actions/workflows/linting-and-unit-testing.yml)
[](https://codecov.io/gh/paazmaya/shuji)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fpaazmaya%2Fshuji?ref=badge_shield)
## Background for the name
The name of the project is for honouring the legacy of a certain master from the Ryukyu archipelago who contributed to the martial arts that we today know as **karate** and **ryukyu kobujutsu**.
## Getting started
Install the `shuji` command line utility globally with [npm](https://www.npmjs.com/).
Elevated privileges might be needed via `sudo`, depending on the platform. In most cases just:
```sh
npm install --global shuji
```
Usage example:
```sh
shuji file.js.map -o folder
```
Please note that the minimum supported version of [Node.js](https://nodejs.org/en/) is `14.15.0`, which is [the active Long Term Support (LTS) version](https://github.com/nodejs/Release#release-schedule).
## Command line options
The output of `shuji --help` pretty much covers all the options:
```sh
shuji - Reverse engineering JavaScript and CSS sources from sourcemaps
Usage: shuji [options]
-h, --help Help and usage instructions
-o, --output-dir String Output directory - default: .
-p, --preserve Preserve sourcemap's original folder structure.
-M, --match String Regular expression for matching and filtering files -
default: \.map$
-v, --verbose Verbose output, will print which file is currently being
processed
-V, --version Version number
Version 0.8.0
```
## Testing
Test files are generated with [UglifyJS 3](https://www.npmjs.com/package/uglify-js) and
[`sass`](https://sass-lang.com/install)
by using files from the [stretchy](https://github.com/LeaVerou/stretchy) project,
with the following commands:
```sh
uglifyjs stretchy.js --compress --mangle \
--output stretchy.min.js --source-map includeSources
mv stretchy.min.js.map stretchy-with-sources.min.js.map
uglifyjs stretchy.js --compress --mangle \
--output stretchy.min.js --source-map "url=inline"
mv stretchy.min.js stretchy-inline-sources.min.js
uglifyjs stretchy.js --compress --mangle \
--output stretchy.min.js --source-map "url=stretchy.min.js.map"
sass stretchy.scss:stretchy.css
sass stretchy.scss:stretchy-inline.css --embed-source-map
```
Unit tests are written with [`tape`](https://github.com/substack/tape) and can be executed with `npm test`.
Code coverage is inspected with [`nyc`](https://github.com/istanbuljs/nyc) and
can be executed with `npm run coverage` after running `npm test`.
Please make sure it is over 90% at all times.
## Contributing
["A Beginner's Guide to Open Source: The Best Advice for Making your First Contribution"](http://www.erikaheidi.com/blog/a-beginners-guide-to-open-source-the-best-advice-for-making-your-first-contribution/).
[Also there is a blog post about "45 Github Issues Dos and Don’ts"](https://davidwalsh.name/45-github-issues-dos-donts).
Linting is done with [ESLint](http://eslint.org) and can be executed with `npm run lint`.
There should be no errors appearing after any JavaScript file changes.
Please note that any features or changed will not be merged without working unit tests.
## Version history
[Changes happening across different versions and upcoming changes are tracked in the `CHANGELOG.md` file.](CHANGELOG.md)
## License
Copyright (c) [Juga Paazmaya](https://paazmaya.fi)
Licensed under [the MIT license](./LICENSE).
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fpaazmaya%2Fshuji?ref=badge_large)