Merge pull request #1 from avoidwork/master

Merge latest

Author: gurpreetbaidwan

.eslintrc

@@ -6,7 +6,7 @@
     "amd": true
   },
   "parserOptions": {
-    "ecmaVersion": 2020,
+    "ecmaVersion": "latest",
     "sourceType": "module"
   },
   "globals": {

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+---
+name: ci
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Setup Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          always-auth: false
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run rollup
+
+      - name: Run Tests
+        run: npm run test
+
+  automerge:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: fastify/github-action-merge-dependabot@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

README.md

@@ -61,6 +61,27 @@ _*(string)*_ Standard unit of measure, can be `iec` or `jedec`, default is `iec`
 ### symbols
 _*(object)*_ Dictionary of IEC/JEDEC symbols to replace for localization, defaults to english if no match is found
 
+## Examples
+
+```javascript
+filesize(500);                        // "500 B"
+filesize(500, {bits: true});          // "4 kbit"
+filesize(265318, {base: 2});          // "259.1 KiB"
+filesize(265318);                     // "265.32 kB"
+filesize(265318, {round: 0});         // "265 kB"
+filesize(265318, {output: "array"});  // [265.32, "kB"]
+filesize(265318, {output: "object"}); // {value: 265.32, symbol: "kB", exponent: 1, unit: "kB"}
+filesize(1, {symbols: {B: "Б"}});     // "1 Б"
+filesize(1024);                       // "1.02 kB"
+filesize(1024, {exponent: 0});        // "1024 B"
+filesize(1024, {output: "exponent"}); // 1
+filesize(265318, {standard: "jedec"});  // "259.1 KB"
+filesize(265318, {base: 2, fullform: true}); // "259.1 kibibytes"
+filesize(12, {fullform: true, fullforms: ["байтов"]});  // "12 байтов"
+filesize(265318, {separator: ","});   // "265,32 kB"
+filesize(265318, {locale: "de"});   // "265,32 kB"
+```
+
 
 ## Partial Application
 `partial()` takes the second parameter of `filesize()` and returns a new function with the configuration applied 

package-lock.json

@@ -33,12 +33,14 @@
     "rollup": "rollup --config",
     "test": "npm run lint && npm run mocha",
     "test-webpack": "mkdir -p test/webpack && rm -rf test/webpack/* && git clone [email protected]:rabelais88/typescript-webpack.git test/webpack && echo \"import { filesize } from 'filesize';console.log(filesize(1234));\" >> test/webpack/src/index.ts && cd test/webpack && npm install && mkdir -p node_modules/filesize/dist && cp ../../package.json node_modules/filesize/ && cp ../../dist/* node_modules/filesize/dist/ && npm run build",
-    "types": "npx -p typescript tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types"
+    "types": "npx -p typescript tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types",
+    "prepare": "husky install"
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.0",
     "auto-changelog": "^2.4.0",
     "eslint": "^8.37.0",
+    "husky": "^8.0.3",
     "mocha": "^10.2.0",
     "rollup": "^3.20.2",
     "typescript": "^5.0.2"