Skip to content

Commit 8073512

Browse files
committed
⚡ maintenance update (dev dependencies, ci refact)
1 parent 92eb924 commit 8073512

320 files changed

Lines changed: 15566 additions & 12156 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/npm-publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ on:
66
jobs:
77
build:
88
runs-on: ubuntu-latest
9+
environment: default
910
steps:
10-
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
11-
# Setup .npmrc file to publish to npm
12-
- uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
11+
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
12+
- uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
1313
with:
1414
node-version: '16.x'
1515
registry-url: 'https://registry.npmjs.org'

.npmrc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
22
registry=https://registry.npmjs.org/
3-
always-auth=true

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pipe( $.xdg.temp, s.mkdir )("foo bar");
2525
Open ‘▸’ sections for quick overview and/or navigate to link(s) for more detailed
2626
information and documentation.
2727

28-
<!-- #region --><details> <summary><a href="./docs/namespaces/s/README.md">s #shelljs</a> namespace <em>(unix shell-like commands in JavaScript)</em></summary>
28+
<!-- #region --><details> <summary><a href="./docs/nodejsscript/namespaces/s/README.md">s #shelljs</a> namespace <em>(unix shell-like commands in JavaScript)</em></summary>
2929

3030
```js
3131
s.ls().forEach(echo); // ShellArray
@@ -41,7 +41,7 @@ and some additional added by nodejsscript. Typically `s.cat`/`s.grep`/…,
4141
to run other than builtin commands use `s.run`/`s.runA`.
4242

4343
These functions returns `ShellArray`/`ShellString`/`Promise<ShellString>`,
44-
these types are union types of `string[]`/`string` with [`ShellReturnValueNJS`](./docs/namespaces/s/interfaces/ShellReturnValueNJS.md).
44+
these types are union types of `string[]`/`string` with [`ShellReturnValueNJS`](./docs/nodejsscript/namespaces/s/interfaces/ShellReturnValueNJS.md).
4545
In simple terms, you can use it as `string[]`/`string`/`Promise<string>` or
4646
read the commad exit `code` and `stdout`/`stderr`. If it makes sence, you can
4747
pipe output to other shelljs commands. Special pipeing is `to`/`toEnd` for
@@ -53,9 +53,9 @@ s.echo("Hello World!").to("hello.txt");
5353

5454
<!-- #endregion -->
5555
</details>
56-
<!-- #region --><details> <summary><a href="./docs/namespaces/$/README.md">$</a> (
57-
<a href="./docs/namespaces/$/functions/api.md">$.api() #sade</a>,
58-
<a href="./docs/namespaces/xdg/namespaces/xdg/README.md">$.xdg</a>,
56+
<!-- #region --><details> <summary><a href="./docs/nodejsscript/namespaces/$/README.md">$</a> (
57+
<a href="./docs/nodejsscript/namespaces/$/functions/api.md">$.api() #sade</a>,
58+
<a href="./docs/nodejsscript/namespaces/xdg/namespaces/xdg/README.md">$.xdg</a>,
5959
6060
)
6161
namespace <em>(nodejsscript/cli related functions/variables)</em></summary>
@@ -93,11 +93,11 @@ $.api()
9393
(home, temp, config, … directory)
9494
- `$.stdin`: handles standard input when the script is run in shell pipe (can be
9595
helpful for `nodejsscript --eval`/`nodejsscript --print` bellow)
96-
- …for more see [related section in docs](./docs/namespaces/$/README.md)
96+
- …for more see [related section in docs](./docs/nodejsscript/namespaces/$/README.md)
9797

9898
<!-- #endregion -->
9999
</details>
100-
<!-- #region --><details> <summary><a href="./docs/functions/echo.md">echo() #css-in-console</a> function/namespace</summary>
100+
<!-- #region --><details> <summary><a href="./docs/variables/echo.md">echo() #css-in-console</a> function/namespace</summary>
101101

102102
```js
103103
const css= echo.css`
@@ -293,9 +293,7 @@ You don’t need this hack if you use `nodejsscript` in your project locally.
293293
</details>
294294
295295
## Quick links/info
296-
- migration from *0.9.\**: see [API changes 0.9 → 1.0](https://github.com/jaandrle/nodejsscript/pull/32)
297-
- migration from *0.8.\**: see [API changes 0.8 → 0.9](https://github.com/jaandrle/nodejsscript/blob/e9c4d9d/README.md#api-changes-08--09)
298-
- [migration from `zx`](#migration-from-zx)
296+
- changelogs and migrations info: see [Release notes](https://github.com/jaandrle/nodejsscript/releases)
299297
- [**You (may) not need to use `nodejsscript`**](./examples/no-nodejsscript.md)
300298
- [Ideas (for new features)](https://github.com/jaandrle/nodejsscript/discussions/categories/ideas)
301299
- Examples: [examples folder](./examples) or [Show And Tell · Discussions](https://github.com/jaandrle/nodejsscript/discussions/categories/show-and-tell)

bs/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
[jaandrle/bs: The simplest possible build system using executables](https://github.com/jaandrle/bs)
1+
# bs: Build system based on executables
2+
This project uses [jaandrle/bs: The simplest possible build system using executable/bash scripts](https://github.com/jaandrle/bs).
3+
4+
## Available executables
5+
6+
### bs/build.mjs
7+
This lints code an run all build tasks
8+
9+
### bs/build/doc.mjs
10+
### bs/dev/lint.mjs

bs/build.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env -S npx nodejsscript
22
/* jshint esversion: 11,-W097, -W040, module: true, node: true, expr: true, undef: true *//* global $ */
33
$.configAssign({ fatal: true });
4-
import "./build:lint.mjs";
5-
import "./build:doc.mjs";
4+
import "./dev/lint.mjs";
5+
import "./build/doc.mjs";

bs/build:doc.mjs renamed to bs/build/doc.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,12 @@ await section("Cleanup documentation...", ()=> {
6969
await section("Generating tldr pages...", async ()=> {
7070
const path_tldr= "tldr.md";
7171
// shelljs original
72-
await fetch("https://github.com/shelljs/shelljs/raw/master/README.md")
72+
await fetch("https://github.com/shelljs/shelljs/raw/main/README.md")
7373
.then(res=> res.text())
7474
.then(pipe(
7575
md=> md.slice(md.indexOf("### "), md.indexOf("\n### ShellString(str)")),
7676
pipe(
77+
cutOut("cmd"),
7778
cutOut("echo"),
7879
cutOut("exec"),
7980
cutOut("set"),
File renamed without changes.

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
## Public
55
- [pipe](functions/pipe.md)
66
- [fetch](functions/fetch.md)
7-
- [echo](functions/echo.md)
8-
- [$](namespaces/$/README.md)
9-
- [s](namespaces/s/README.md)
7+
- [echo](variables/echo.md)
8+
- [$](nodejsscript/namespaces/$/README.md)
9+
- [s](nodejsscript/namespaces/s/README.md)
1010
## Internal
1111

1212
## Public Functions

docs/namespaces/s/namespaces/child/README.md renamed to docs/child_process/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
[**nodejsscript**](../../../../README.md)**Docs**
1+
[**nodejsscript**](../README.md)
22

33
***
44

5-
[nodejsscript](../../../../README.md) / [s](../../README.md) / child
5+
[nodejsscript](../README.md) / [s](../nodejsscript/namespaces/s/README.md) / child\_process
66

7-
# child
7+
# child\_process
88

9-
## Index
10-
11-
### Namespaces
9+
## Namespaces
1210

1311
- [exec](namespaces/exec/README.md)
1412
- [execFile](namespaces/execFile/README.md)
1513

16-
### Classes
14+
## Classes
1715

1816
- [ChildProcess](classes/ChildProcess.md)
1917

20-
### Interfaces
18+
## Interfaces
2119

20+
- [ChildProcessEventMap](interfaces/ChildProcessEventMap.md)
2221
- [ChildProcessWithoutNullStreams](interfaces/ChildProcessWithoutNullStreams.md)
2322
- [ChildProcessByStdio](interfaces/ChildProcessByStdio.md)
23+
- [Control](interfaces/Control.md)
2424
- [MessageOptions](interfaces/MessageOptions.md)
2525
- [MessagingOptions](interfaces/MessagingOptions.md)
2626
- [ProcessEnvOptions](interfaces/ProcessEnvOptions.md)
@@ -37,7 +37,7 @@
3737
- [ExecFileOptions](interfaces/ExecFileOptions.md)
3838
- [ExecFileOptionsWithStringEncoding](interfaces/ExecFileOptionsWithStringEncoding.md)
3939
- [ExecFileOptionsWithBufferEncoding](interfaces/ExecFileOptionsWithBufferEncoding.md)
40-
- [ExecFileOptionsWithOtherEncoding](interfaces/ExecFileOptionsWithOtherEncoding.md)
40+
- [~~ExecFileOptionsWithOtherEncoding~~](interfaces/ExecFileOptionsWithOtherEncoding.md)
4141
- [ForkOptions](interfaces/ForkOptions.md)
4242
- [SpawnSyncOptions](interfaces/SpawnSyncOptions.md)
4343
- [SpawnSyncOptionsWithStringEncoding](interfaces/SpawnSyncOptionsWithStringEncoding.md)
@@ -51,7 +51,7 @@
5151
- [ExecFileSyncOptionsWithStringEncoding](interfaces/ExecFileSyncOptionsWithStringEncoding.md)
5252
- [ExecFileSyncOptionsWithBufferEncoding](interfaces/ExecFileSyncOptionsWithBufferEncoding.md)
5353

54-
### Type Aliases
54+
## Type Aliases
5555

5656
- [Serializable](type-aliases/Serializable.md)
5757
- [SendHandle](type-aliases/SendHandle.md)
@@ -63,7 +63,7 @@
6363
- [StdioPipe](type-aliases/StdioPipe.md)
6464
- [ExecFileException](type-aliases/ExecFileException.md)
6565

66-
### Functions
66+
## Functions
6767

6868
- [spawn](functions/spawn.md)
6969
- [exec](functions/exec.md)

0 commit comments

Comments
 (0)