Fork the project as a library for programmatic usage only

* Rename the package to unix-permissions-lib
* Expose ES, CJS and UMD exports, TypeScript types remain included
* Remove the command-line interface together with the documentation and tests
* Add VS Code settings

Author: prantlf

.all-contributorsrc

@@ -1,5 +1,5 @@
 {
-  "projectName": "unix-permissions",
+  "projectName": "unix-permissions-lib",
   "projectOwner": "ehmicky",
   "repoType": "github",
   "repoHost": "https://github.com",
@@ -21,6 +21,13 @@
         "ideas",
         "doc"
       ]
+    },
+    {
+      "login": "prantlf",
+      "name": "Ferdinand Prantl",
+      "contributions": [
+        "build"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -47,7 +47,7 @@ body:
       description: |
         Enter the following command in a terminal and copy/paste its output:
         ```bash
-        npx envinfo --system --binaries --browsers --npmPackages unix-permissions
+        npx envinfo --system --binaries --browsers --npmPackages unix-permissions-lib
         ```
     validations:
       required: true

.github/ISSUE_TEMPLATE/bug_types.yml

@@ -33,7 +33,7 @@ body:
       description: |
         Enter the following command in a terminal and copy/paste its output:
         ```bash
-        npx envinfo --system --binaries --browsers --npmPackages unix-permissions typescript --npmGlobalPackages typescript
+        npx envinfo --system --binaries --browsers --npmPackages unix-permissions-lib typescript --npmGlobalPackages typescript
         ```
     validations:
       required: true

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "files.exclude": {
+    "**/.git": true,
+    "**/.DS_Store": true,
+    "**/Thumbs.db": true,
+    ".eslintcache": true,
+    "build": true,
+    "dist": true
+  }
+}

README.md

@@ -3,22 +3,22 @@
   <img alt="unix-permissions logo" src="https://raw.githubusercontent.com/ehmicky/design/main/unix-permissions/unix-permissions.png" width="500"/>
 </picture>
 
-[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js&colorA=404040&logoColor=66cc33)](https://www.npmjs.com/package/unix-permissions)
-[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox&colorA=404040)](https://unpkg.com/unix-permissions?module)
+[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js&colorA=404040&logoColor=66cc33)](https://www.npmjs.com/package/unix-permissions-lib)
+[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox&colorA=404040)](https://unpkg.com/unix-permissions-lib?module)
 [![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript&colorA=404040&logoColor=0096ff)](/src/main.d.ts)
-[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov&colorA=404040)](https://codecov.io/gh/ehmicky/unix-permissions)
-[![Minified size](https://img.shields.io/bundlephobia/minzip/unix-permissions?label&colorA=404040&colorB=808080&logo=webpack)](https://bundlephobia.com/package/unix-permissions)
-[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon&colorA=404040&logoColor=9590F9)](https://fosstodon.org/@ehmicky)
-[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium&colorA=404040)](https://medium.com/@ehmicky)
+[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov&colorA=404040)](https://codecov.io/gh/prantlf/unix-permissions)
+[![Minified size](https://img.shields.io/bundlephobia/minzip/unix-permissions-lib?label&colorA=404040&colorB=808080&logo=webpack)](https://bundlephobia.com/package/unix-permissions-lib)
 
-Swiss Army knife for Unix permissions.
+Swiss Army knife for Unix permissions - a library for programmatic usage only.
+
+This is a fork to be used as a library which offers ES, CJS and UMD module formats as exports. If you need only the ES export or want to use the command line tool, use the [original project](https://github.com/ehmicky/unix-permissions).
 
 [Unix file permissions](https://en.wikipedia.org/wiki/File_system_permissions)
 can take many [shapes](#permission-types): [symbolic](docs/types.md#symbolic)
 (`ug+rw`), [octal](docs/types.md#octal) (`660`) or a
 [list of characters](docs/types.md#stat) (`drw-rw----`). This library enables
 using any of [these](#permission-types) (instead of being limited to a single
-one) with any [Node.js](#examples-javascript) or [CLI command](#examples-cli).
+one) with any [Node.js](#examples-javascript).
 
 This library can also perform operations on Unix permissions such as:
 
@@ -44,12 +44,10 @@ using those strings.
 
 # Examples
 
-In JavaScript:
-
 <!-- eslint-disable n/no-sync -->
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 // Retrieve a file's permission as an object like
 // `{ user: { write: false, read: true, ... }, ... }` instead of a number
@@ -65,33 +63,24 @@ fs.writeFile('/my/file', content, { mode: convert.number('a=r') })
 process.umask(convert.number(invert('a-x')))
 
 // If your library takes Unix permissions as input, using
-// `unix-permissions` under the hood lets your users choose their
+// `unix-permissions-lib` under the hood lets your users choose their
 // favorite Unix permissions type.
 myLibrary.method({ mode: 'a-wx' })
 myLibrary.method({ mode: '444' })
 ```
 
-On the command line:
-
-```bash
-$ stat -c "%a" /etc/passwd
-644
-
-$ unix-permissions convert.symbolic "$(stat -c "%a" /etc/passwd)"
-u=rw,go=r
-```
-
 # Demo
 
 You can try this library:
 
-- either directly [in your browser](https://repl.it/@ehmicky/unix-permissions).
+- either directly
+  [in your browser](https://repl.it/@prantlf/unix-permissions-lib).
 - or by executing the [`examples` files](examples/README.md) in a terminal.
 
 # Install
 
 ```bash
-npm install unix-permissions
+npm install unix-permissions-lib
 ```
 
 This package works in both Node.js >=14.18.0 and
@@ -106,7 +95,7 @@ not CommonJS.
 # Usage (JavaScript)
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 // `permission` will be set to `rw-rw----`
 const permission = convert.stat('660')
@@ -115,16 +104,6 @@ const permission = convert.stat('660')
 Several methods other than `convert` are available but they mostly follow the
 same pattern. Permission strings are passed as input and returned as output.
 
-# Usage (CLI)
-
-```bash
-$ unix-permissions convert.stat 660
-rw-rw----
-```
-
-The same methods as in JavaScript are available. Exit code will be `1` if an
-error occurred, e.g. if the permission syntax is invalid.
-
 # Permission types
 
 You can use any of the following permission types as input. You can also

docs/API.md

@@ -1,12 +1,12 @@
 # API
 
-The following methods are available both in
-[JavaScript](../README.md#usage-javascript) and on the
-[command line](../README.md#usage-cli).
+The following methods are available in
+[JavaScript](../README.md#usage-javascript).
 
 You can try all the examples below:
 
-- either directly [in your browser](https://repl.it/@ehmicky/unix-permissions).
+- either directly
+  [in your browser](https://repl.it/@prantlf/unix-permissions-lib).
 - or by executing the [`examples` files](../examples/README.md) in a terminal.
 
 All methods (except [`type()`](#typepermission)) throw an exception if the
@@ -30,7 +30,7 @@ mean "unset permissions". However you can use
 [`positive()`](#positivepermission) to overcome this issue.
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.symbolic('111')) // 'a=x'
 console.log(positive(convert.symbolic('111'))) // 'a+x'
@@ -49,7 +49,7 @@ try {
 Returns the `permission`'s [`type`](types.md) or `'invalid'`.
 
 ```js
-import { type } from 'unix-permissions'
+import { type } from 'unix-permissions-lib'
 
 console.log(type('1')) // 'octal'
 console.log(type(1)) // 'number'
@@ -64,7 +64,7 @@ Normalizes a `permission` to its canonical shape.
 Throws an exception if `permission` is invalid.
 
 ```js
-import { normalize } from 'unix-permissions'
+import { normalize } from 'unix-permissions-lib'
 
 console.log(normalize('1')) // '0001'
 console.log(normalize('g+x,o+x')) // 'go+x'
@@ -86,7 +86,7 @@ Removes all negative permissions. See
 explanation.
 
 ```js
-import { positive, invert } from 'unix-permissions'
+import { positive, invert } from 'unix-permissions-lib'
 
 console.log(positive('o+x,o-rw')) // 'o+x'
 console.log(positive('o=x')) // 'o+x'
@@ -99,10 +99,10 @@ console.log(invert(positive('660'))) // '-0660'
 
 Tests whether `permission` includes `permissions`.
 
-Returns `true` or `false` or (on the CLI) use the exit code `0` or `1`.
+Returns `true` or `false`.
 
 ```js
-import { contain } from 'unix-permissions'
+import { contain } from 'unix-permissions-lib'
 
 console.log(contain('--x--x--x', 'a=x')) // `true`
 console.log(contain('--x--x--x', 'a+x')) // `true`
@@ -120,10 +120,10 @@ console.log(contain('o+x,o-w', 'o+x', 'o-w')) // `true`
 
 Tests whether `permission` equals exactly `permissions`.
 
-Returns `true` or `false` or (on the CLI) use the exit code `0` or `1`.
+Returns `true` or `false`.
 
 ```js
-import { equal } from 'unix-permissions'
+import { equal } from 'unix-permissions-lib'
 
 console.log(equal('--x--x--x', 'a=x')) // `true`
 console.log(equal('--x--x--x', 'a+x')) // `false`
@@ -148,7 +148,7 @@ This can also be used to remove special permissions using
 [`umask`](https://linux.die.net/man/2/umask) do not allow them.
 
 ```js
-import { set } from 'unix-permissions'
+import { set } from 'unix-permissions-lib'
 
 console.log(set('---------', 'a+x')) // '--x--x--x'
 console.log(set('---------', 'a+x', 'a+r')) // 'r-xr-xr-x'
@@ -165,7 +165,7 @@ This can be used in combination with `set()` to unset `permissions` instead of
 setting them.
 
 ```js
-import { not, set } from 'unix-permissions'
+import { not, set } from 'unix-permissions-lib'
 
 console.log(not('u+xs')) // 'u-xs'
 console.log(not('u-xs')) // 'u+xs'
@@ -187,7 +187,7 @@ For example a [`umask`](https://linux.die.net/man/2/umask) of `117` means new
 files will be created with `661` permissions.
 
 ```js
-import { invert } from 'unix-permissions'
+import { invert } from 'unix-permissions-lib'
 
 console.log(invert('u+xs')) // 'u-x'
 console.log(invert('u-xs')) // 'u+x'
@@ -209,7 +209,7 @@ This can be useful if you are looking for the lowest permission of a several
 files, e.g. during a directory recursion.
 
 ```js
-import { min } from 'unix-permissions'
+import { min } from 'unix-permissions-lib'
 
 console.log(min('404', '440', '402')) // '0400'
 ```
@@ -219,7 +219,7 @@ console.log(min('404', '440', '402')) // '0400'
 Inverse of [`min()`](#minpermissions).
 
 ```js
-import { max } from 'unix-permissions'
+import { max } from 'unix-permissions-lib'
 
 console.log(max('404', '440', '402')) // '0446'
 ```

docs/types.md

@@ -6,7 +6,8 @@ them.
 
 You can try all the examples below:
 
-- either directly [in your browser](https://repl.it/@ehmicky/unix-permissions).
+- either directly
+  [in your browser](https://repl.it/@prantlf/unix-permissions-lib).
 - or by executing the [`examples` files](../examples/README.md) in a terminal.
 
 ## octal
@@ -28,7 +29,7 @@ An operator can be prepended:
 - `-`: unset specified permissions
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.stat('720')) // 'rwx-w----'
 console.log(convert.stat('7000')) // '--S--S--T'
@@ -49,12 +50,10 @@ It is the same as `octal` except:
 
 - as a decimal number.
 - no operator can be used.
-- it can be used as input in [JavaScript](../README.md#usage-javascript) but not
-  on the [command line](../README.md#usage-cli), where all numbers should be in
-  [`octal`](#octal) form instead.
+- it can be used as input in [JavaScript](../README.md#usage-javascript).
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.stat(0)) // '---------'
 console.log(convert.stat(1)) // '--------x'
@@ -76,7 +75,7 @@ Optionally a first character can be specified to indicate the file type (e.g.
 `d` for directories).
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.octal('--------x')) // '0001'
 console.log(convert.octal('--x--x--x')) // '0111'
@@ -105,7 +104,7 @@ Several groups can be specified using a comma-separated list like `g+x,o+r`.
 User classes can be concatenated like `go+x`.
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.octal('o+wx')) // '+0003'
 console.log(convert.octal('o=wx')) // '0003'
@@ -137,7 +136,7 @@ The values can be `true`, `false` or `undefined`. `undefined` leaves permissions
 as is while `false` unsets them.
 
 ```js
-import { convert } from 'unix-permissions'
+import { convert } from 'unix-permissions-lib'
 
 console.log(convert.symbolic({ others: { read: true, execute: true } }))
 // 'o+rx'
@@ -159,9 +158,3 @@ console.log(
 )
 // 'ug+s,o+t'
 ```
-
-On the command line:
-
-```bash
-unix-permissions convert.symbolic '{ "all": { "read": true } }' # a+r
-```