Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/berkmann18/hashmyjs

A simple NodeJS program that hashes JS files/codes and output it on the terminal or in files or via variables
https://github.com/berkmann18/hashmyjs

base64 csp hashing integrity nodejs sha-256

Last synced: 6 months ago
JSON representation

A simple NodeJS program that hashes JS files/codes and output it on the terminal or in files or via variables

Awesome Lists containing this project

README 

          
# HashMyJS

[![NPM](https://nodei.co/npm/hashmyjs.png)](https://nodei.co/npm/hashmyjs/)



[![Build Status](https://travis-ci.org/Berkmann18/hashmyjs.svg?branch=master)](https://travis-ci.org/Berkmann18/hashmyjs)

[![codecov.io Code Coverage](https://img.shields.io/codecov/c/github/Berkmann18/hashmyjs.svg?maxAge=2592000)](https://codecov.io/github/Berkmann18/hashmyjs?branch=master)

[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

[![Known Vulnerabilities](https://snyk.io/test/github/Berkmann18/hashmyjs/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Berkmann18/hashmyjs?targetFile=package.json)



[![GitHub](https://img.shields.io/github/license/Berkmann18/hashmyjs.svg)](https://github.com/Berkmann18/hashmyjs/blob/master/LICENSE)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/Berkmann18/hashmyjs/issues)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&identifier=115825259)](https://dependabot.com)



[![GitHub top language](https://img.shields.io/github/languages/top/Berkmann18/hashmyjs.svg)](https://github.com/Berkmann18/hashmyjs)

[![GitHub language count](https://img.shields.io/github/languages/count/Berkmann18/hashmyjs.svg)](https://github.com/Berkmann18/hashmyjs)

[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Berkmann18/hashmyjs.svg)](https://github.com/Berkmann18/hashmyjs)



[![Inline docs](http://inch-ci.org/github/Berkmann18/hashmyjs.svg?branch=master)](http://inch-ci.org/github/Berkmann18/hashmyjs)

[![BCH compliance](https://bettercodehub.com/edge/badge/Berkmann18/hashmyjs?branch=master)](https://bettercodehub.com/results/Berkmann18/hashmyjs)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/dcb7d393f7f24c0c9717e1254f6967c9)](https://app.codacy.com/app/maxieberkmann/hashmyjs?utm_source=github.com&utm_medium=referral&utm_content=Berkmann18/hashmyjs&utm_campaign=Badge_Grade_Dashboard)



It's a relatively simple NodeJS program that allows you to get the base64 encoded SHA-256 hash for a JS file or the code itself that you could later on use as the integrity of a script that you would integrate to a page so it won't be flagged by CSP or else.



## Install

To install it you need to execute the following:

```cli

npm i hashmyjs

```



_Note_: Don't forget to use `-g`, `--save`, `--save-dev` if appropriate.



## Usage

### In NodeJS

```js

const hmj = require('hashmyjs');



//Hashing from the STDIN (followed by a new line: `\$`, `\EOF`) or from file passed as arguments

hmj.run();



//Or if you want to hash code that is already present in your script:

let code = `...`;

let digest = hmj.hash(code);

```



### In the CLI

```bash

hashmyjs -- [options] [files] #If used via an npm script

```

**Help**:

```cli

Usage: hashmyjs [options] [files...]



  A simple NodeJS JS file/code hasher.



  Options:



    -V, --version          output the version number

    -f, --format [format]  Specify the format of the output (text (default), json, csv) (default: text)

    -o, --output [path]    Output to a file instead of in the STDOUT (default: stdout)

    -i, --interactive      Forces to read the input from the STDIN

    -p, --prettify         Prettify the output

    -h, --help             output usage information

```



## Nota bene

If you use wildcard `*` in the CLI to get files, NodeJS will have a hard time getting the file from the right URL so it will lead in errors.



## Documentation

See [this](./DOCUMENTATION.md) for more information.



## Contribution

If you discover bugs, errors or/and have suggestions/feedback please create an [issue](http://github.com/Berkmann18/hashmyjs/issues) or/and submit a [PR](http://github.com/Berkmann18/hashmyjs/pulls).



If you want to contribute, make sure you stick with the coding style that ESLint is enforcing (cf. configuration file).

To check if a file stick to the standards:

```cli

eslint -c ./config/.eslintrc.js yourFile.js

#Or `npm lint` if appropriate

```

To fix formatting errors and such, run:

```cli

./fixjs.sh [your js files seperated by spaces]

```



## Contributors



| [Maximilian Berkmann
Maximilian Berkmann](http://maxcubing.wordpress.com)
[🐛](https://github.com/Berkmann18/hashmyjs/issues?q=author%3ABerkmann18 "Bug reports") [💻](https://github.com/Berkmann18/hashmyjs/commits?author=Berkmann18 "Code") [📖](https://github.com/Berkmann18/hashmyjs/commits?author=Berkmann18 "Documentation") [🤔](#ideas-Berkmann18 "Ideas, Planning, & Feedback") [💬](#question-Berkmann18 "Answering Questions") [👀](#review-Berkmann18 "Reviewed Pull Requests") [🛡️](#security-Berkmann18 "Security") [⚠️](https://github.com/Berkmann18/hashmyjs/commits?author=Berkmann18 "Tests") | [Dependabot
Dependabot](https://dependabot.com)
[🔧](#tool-dependabot-bot "Tools") | [Semantic Release Bot
Semantic Release Bot](http://semantic-release.org/)
[📖](https://github.com/Berkmann18/hashmyjs/commits?author=semantic-release-bot "Documentation") [📦](#platform-semantic-release-bot "Packaging/porting to new platform") | [Codacy Badger
Codacy Badger](https://www.codacy.com)
[🚇](#infra-codacy-badger "Infrastructure (Hosting, Build-Tools, etc)") |

| :---: | :---: | :---: | :---: |