├── .commitlintrc.js
├── .eslintrc.js
├── .github
├── CODEOWNERS
├── ISSUE_TEMPLATE
│ ├── bug.yml
│ └── config.yml
├── actions
│ ├── create-check
│ │ └── action.yml
│ └── install-latest-npm
│ │ └── action.yml
├── dependabot.yml
├── matchers
│ └── tap.json
├── settings.yml
└── workflows
│ ├── audit.yml
│ ├── ci-release.yml
│ ├── ci.yml
│ ├── codeql-analysis.yml
│ ├── post-dependabot.yml
│ ├── pull-request.yml
│ ├── release-integration.yml
│ └── release.yml
├── .gitignore
├── .npmrc
├── .release-please-manifest.json
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── lib
└── index.js
├── package.json
├── release-please-config.json
└── test
└── basic.js
/.commitlintrc.js:
--------------------------------------------------------------------------------
1 | /* This file is automatically added by @npmcli/template-oss. Do not edit. */
2 |
3 | module.exports = {
4 | extends: ['@commitlint/config-conventional'],
5 | rules: {
6 | 'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'deps', 'chore']],
7 | 'header-max-length': [2, 'always', 80],
8 | 'subject-case': [0],
9 | 'body-max-line-length': [0],
10 | 'footer-max-line-length': [0],
11 | },
12 | }
13 |
--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | /* This file is automatically added by @npmcli/template-oss. Do not edit. */
2 |
3 | 'use strict'
4 |
5 | const { readdirSync: readdir } = require('fs')
6 |
7 | const localConfigs = readdir(__dirname)
8 | .filter((file) => file.startsWith('.eslintrc.local.'))
9 | .map((file) => `./${file}`)
10 |
11 | module.exports = {
12 | root: true,
13 | ignorePatterns: [
14 | 'tap-testdir*/',
15 | ],
16 | extends: [
17 | '@npmcli',
18 | ...localConfigs,
19 | ],
20 | }
21 |
--------------------------------------------------------------------------------
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | * @npm/cli-team
4 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Bug
4 | description: File a bug/issue
5 | title: "[BUG]
"
6 | labels: [ Bug, Needs Triage ]
7 |
8 | body:
9 | - type: checkboxes
10 | attributes:
11 | label: Is there an existing issue for this?
12 | description: Please [search here](./issues) to see if an issue already exists for your problem.
13 | options:
14 | - label: I have searched the existing issues
15 | required: true
16 | - type: textarea
17 | attributes:
18 | label: Current Behavior
19 | description: A clear & concise description of what you're experiencing.
20 | validations:
21 | required: false
22 | - type: textarea
23 | attributes:
24 | label: Expected Behavior
25 | description: A clear & concise description of what you expected to happen.
26 | validations:
27 | required: false
28 | - type: textarea
29 | attributes:
30 | label: Steps To Reproduce
31 | description: Steps to reproduce the behavior.
32 | value: |
33 | 1. In this environment...
34 | 2. With this config...
35 | 3. Run '...'
36 | 4. See error...
37 | validations:
38 | required: false
39 | - type: textarea
40 | attributes:
41 | label: Environment
42 | description: |
43 | examples:
44 | - **npm**: 7.6.3
45 | - **Node**: 13.14.0
46 | - **OS**: Ubuntu 20.04
47 | - **platform**: Macbook Pro
48 | value: |
49 | - npm:
50 | - Node:
51 | - OS:
52 | - platform:
53 | validations:
54 | required: false
55 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | blank_issues_enabled: true
4 |
--------------------------------------------------------------------------------
/.github/actions/create-check/action.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: 'Create Check'
4 | inputs:
5 | name:
6 | required: true
7 | token:
8 | required: true
9 | sha:
10 | required: true
11 | check-name:
12 | default: ''
13 | outputs:
14 | check-id:
15 | value: ${{ steps.create-check.outputs.check_id }}
16 | runs:
17 | using: "composite"
18 | steps:
19 | - name: Get Workflow Job
20 | uses: actions/github-script@v7
21 | id: workflow
22 | env:
23 | JOB_NAME: "${{ inputs.name }}"
24 | SHA: "${{ inputs.sha }}"
25 | with:
26 | result-encoding: string
27 | script: |
28 | const { repo: { owner, repo}, runId, serverUrl } = context
29 | const { JOB_NAME, SHA } = process.env
30 |
31 | const job = await github.rest.actions.listJobsForWorkflowRun({
32 | owner,
33 | repo,
34 | run_id: runId,
35 | per_page: 100
36 | }).then(r => r.data.jobs.find(j => j.name.endsWith(JOB_NAME)))
37 |
38 | return [
39 | `This check is assosciated with ${serverUrl}/${owner}/${repo}/commit/${SHA}.`,
40 | 'Run logs:',
41 | job?.html_url || `could not be found for a job ending with: "${JOB_NAME}"`,
42 | ].join(' ')
43 | - name: Create Check
44 | uses: LouisBrunner/checks-action@v1.6.0
45 | id: create-check
46 | with:
47 | token: ${{ inputs.token }}
48 | sha: ${{ inputs.sha }}
49 | status: in_progress
50 | name: ${{ inputs.check-name || inputs.name }}
51 | output: |
52 | {"summary":"${{ steps.workflow.outputs.result }}"}
53 |
--------------------------------------------------------------------------------
/.github/actions/install-latest-npm/action.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: 'Install Latest npm'
4 | description: 'Install the latest version of npm compatible with the Node version'
5 | inputs:
6 | node:
7 | description: 'Current Node version'
8 | required: true
9 | runs:
10 | using: "composite"
11 | steps:
12 | # node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
13 | - name: Update Windows npm
14 | if: |
15 | runner.os == 'Windows' && (
16 | startsWith(inputs.node, 'v10.') ||
17 | startsWith(inputs.node, 'v12.') ||
18 | startsWith(inputs.node, 'v14.')
19 | )
20 | shell: cmd
21 | run: |
22 | curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
23 | tar xf npm-7.5.4.tgz
24 | cd package
25 | node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
26 | cd ..
27 | rmdir /s /q package
28 | - name: Install Latest npm
29 | shell: bash
30 | env:
31 | NODE_VERSION: ${{ inputs.node }}
32 | working-directory: ${{ runner.temp }}
33 | run: |
34 | MATCH=""
35 | SPECS=("latest" "next-10" "next-9" "next-8" "next-7" "next-6")
36 |
37 | echo "node@$NODE_VERSION"
38 |
39 | for SPEC in ${SPECS[@]}; do
40 | ENGINES=$(npm view npm@$SPEC --json | jq -r '.engines.node')
41 | echo "Checking if node@$NODE_VERSION satisfies npm@$SPEC ($ENGINES)"
42 |
43 | if npx semver -r "$ENGINES" "$NODE_VERSION" > /dev/null; then
44 | MATCH=$SPEC
45 | echo "Found compatible version: npm@$MATCH"
46 | break
47 | fi
48 | done
49 |
50 | if [ -z $MATCH ]; then
51 | echo "Could not find a compatible version of npm for node@$NODE_VERSION"
52 | exit 1
53 | fi
54 |
55 | npm i --prefer-online --no-fund --no-audit -g npm@$MATCH
56 | - name: npm Version
57 | shell: bash
58 | run: npm -v
59 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | version: 2
4 |
5 | updates:
6 | - package-ecosystem: npm
7 | directory: /
8 | schedule:
9 | interval: daily
10 | target-branch: "main"
11 | allow:
12 | - dependency-type: direct
13 | versioning-strategy: increase-if-necessary
14 | commit-message:
15 | prefix: deps
16 | prefix-development: chore
17 | labels:
18 | - "Dependencies"
19 | open-pull-requests-limit: 10
20 |
--------------------------------------------------------------------------------
/.github/matchers/tap.json:
--------------------------------------------------------------------------------
1 | {
2 | "//@npmcli/template-oss": "This file is automatically added by @npmcli/template-oss. Do not edit.",
3 | "problemMatcher": [
4 | {
5 | "owner": "tap",
6 | "pattern": [
7 | {
8 | "regexp": "^\\s*not ok \\d+ - (.*)",
9 | "message": 1
10 | },
11 | {
12 | "regexp": "^\\s*---"
13 | },
14 | {
15 | "regexp": "^\\s*at:"
16 | },
17 | {
18 | "regexp": "^\\s*line:\\s*(\\d+)",
19 | "line": 1
20 | },
21 | {
22 | "regexp": "^\\s*column:\\s*(\\d+)",
23 | "column": 1
24 | },
25 | {
26 | "regexp": "^\\s*file:\\s*(.*)",
27 | "file": 1
28 | }
29 | ]
30 | }
31 | ]
32 | }
33 |
--------------------------------------------------------------------------------
/.github/settings.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | repository:
4 | allow_merge_commit: false
5 | allow_rebase_merge: true
6 | allow_squash_merge: true
7 | squash_merge_commit_title: PR_TITLE
8 | squash_merge_commit_message: PR_BODY
9 | delete_branch_on_merge: true
10 | enable_automated_security_fixes: true
11 | enable_vulnerability_alerts: true
12 |
13 | branches:
14 | - name: main
15 | protection:
16 | required_status_checks: null
17 | enforce_admins: true
18 | block_creations: true
19 | required_pull_request_reviews:
20 | required_approving_review_count: 1
21 | require_code_owner_reviews: true
22 | require_last_push_approval: true
23 | dismiss_stale_reviews: true
24 | restrictions:
25 | apps: []
26 | users: []
27 | teams: [ "cli-team" ]
28 |
--------------------------------------------------------------------------------
/.github/workflows/audit.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Audit
4 |
5 | on:
6 | workflow_dispatch:
7 | schedule:
8 | # "At 08:00 UTC (01:00 PT) on Monday" https://crontab.guru/#0_8_*_*_1
9 | - cron: "0 8 * * 1"
10 |
11 | permissions:
12 | contents: read
13 |
14 | jobs:
15 | audit:
16 | name: Audit Dependencies
17 | if: github.repository_owner == 'npm'
18 | runs-on: ubuntu-latest
19 | defaults:
20 | run:
21 | shell: bash
22 | steps:
23 | - name: Checkout
24 | uses: actions/checkout@v4
25 | - name: Setup Git User
26 | run: |
27 | git config --global user.email "npm-cli+bot@github.com"
28 | git config --global user.name "npm CLI robot"
29 | - name: Setup Node
30 | uses: actions/setup-node@v4
31 | id: node
32 | with:
33 | node-version: 22.x
34 | check-latest: contains('22.x', '.x')
35 | - name: Install Latest npm
36 | uses: ./.github/actions/install-latest-npm
37 | with:
38 | node: ${{ steps.node.outputs.node-version }}
39 | - name: Install Dependencies
40 | run: npm i --ignore-scripts --no-audit --no-fund --package-lock
41 | - name: Run Production Audit
42 | run: npm audit --omit=dev
43 | - name: Run Full Audit
44 | run: npm audit --audit-level=none
45 |
--------------------------------------------------------------------------------
/.github/workflows/ci-release.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: CI - Release
4 |
5 | on:
6 | workflow_dispatch:
7 | inputs:
8 | ref:
9 | required: true
10 | type: string
11 | default: main
12 | workflow_call:
13 | inputs:
14 | ref:
15 | required: true
16 | type: string
17 | check-sha:
18 | required: true
19 | type: string
20 |
21 | permissions:
22 | contents: read
23 | checks: write
24 |
25 | jobs:
26 | lint-all:
27 | name: Lint All
28 | if: github.repository_owner == 'npm'
29 | runs-on: ubuntu-latest
30 | defaults:
31 | run:
32 | shell: bash
33 | steps:
34 | - name: Checkout
35 | uses: actions/checkout@v4
36 | with:
37 | ref: ${{ inputs.ref }}
38 | - name: Setup Git User
39 | run: |
40 | git config --global user.email "npm-cli+bot@github.com"
41 | git config --global user.name "npm CLI robot"
42 | - name: Create Check
43 | id: create-check
44 | if: ${{ inputs.check-sha }}
45 | uses: ./.github/actions/create-check
46 | with:
47 | name: "Lint All"
48 | token: ${{ secrets.GITHUB_TOKEN }}
49 | sha: ${{ inputs.check-sha }}
50 | - name: Setup Node
51 | uses: actions/setup-node@v4
52 | id: node
53 | with:
54 | node-version: 22.x
55 | check-latest: contains('22.x', '.x')
56 | - name: Install Latest npm
57 | uses: ./.github/actions/install-latest-npm
58 | with:
59 | node: ${{ steps.node.outputs.node-version }}
60 | - name: Install Dependencies
61 | run: npm i --ignore-scripts --no-audit --no-fund
62 | - name: Lint
63 | run: npm run lint --ignore-scripts
64 | - name: Post Lint
65 | run: npm run postlint --ignore-scripts
66 | - name: Conclude Check
67 | uses: LouisBrunner/checks-action@v1.6.0
68 | if: steps.create-check.outputs.check-id && always()
69 | with:
70 | token: ${{ secrets.GITHUB_TOKEN }}
71 | conclusion: ${{ job.status }}
72 | check_id: ${{ steps.create-check.outputs.check-id }}
73 |
74 | test-all:
75 | name: Test All - ${{ matrix.platform.name }} - ${{ matrix.node-version }}
76 | if: github.repository_owner == 'npm'
77 | strategy:
78 | fail-fast: false
79 | matrix:
80 | platform:
81 | - name: Linux
82 | os: ubuntu-latest
83 | shell: bash
84 | - name: macOS
85 | os: macos-latest
86 | shell: bash
87 | - name: macOS
88 | os: macos-13
89 | shell: bash
90 | - name: Windows
91 | os: windows-latest
92 | shell: cmd
93 | node-version:
94 | - 18.17.0
95 | - 18.x
96 | - 20.5.0
97 | - 20.x
98 | - 22.x
99 | exclude:
100 | - platform: { name: macOS, os: macos-13, shell: bash }
101 | node-version: 18.17.0
102 | - platform: { name: macOS, os: macos-13, shell: bash }
103 | node-version: 18.x
104 | - platform: { name: macOS, os: macos-13, shell: bash }
105 | node-version: 20.5.0
106 | - platform: { name: macOS, os: macos-13, shell: bash }
107 | node-version: 20.x
108 | - platform: { name: macOS, os: macos-13, shell: bash }
109 | node-version: 22.x
110 | runs-on: ${{ matrix.platform.os }}
111 | defaults:
112 | run:
113 | shell: ${{ matrix.platform.shell }}
114 | steps:
115 | - name: Checkout
116 | uses: actions/checkout@v4
117 | with:
118 | ref: ${{ inputs.ref }}
119 | - name: Setup Git User
120 | run: |
121 | git config --global user.email "npm-cli+bot@github.com"
122 | git config --global user.name "npm CLI robot"
123 | - name: Create Check
124 | id: create-check
125 | if: ${{ inputs.check-sha }}
126 | uses: ./.github/actions/create-check
127 | with:
128 | name: "Test All - ${{ matrix.platform.name }} - ${{ matrix.node-version }}"
129 | token: ${{ secrets.GITHUB_TOKEN }}
130 | sha: ${{ inputs.check-sha }}
131 | - name: Setup Node
132 | uses: actions/setup-node@v4
133 | id: node
134 | with:
135 | node-version: ${{ matrix.node-version }}
136 | check-latest: contains(matrix.node-version, '.x')
137 | - name: Install Latest npm
138 | uses: ./.github/actions/install-latest-npm
139 | with:
140 | node: ${{ steps.node.outputs.node-version }}
141 | - name: Install Dependencies
142 | run: npm i --ignore-scripts --no-audit --no-fund
143 | - name: Add Problem Matcher
144 | run: echo "::add-matcher::.github/matchers/tap.json"
145 | - name: Test
146 | run: npm test --ignore-scripts
147 | - name: Conclude Check
148 | uses: LouisBrunner/checks-action@v1.6.0
149 | if: steps.create-check.outputs.check-id && always()
150 | with:
151 | token: ${{ secrets.GITHUB_TOKEN }}
152 | conclusion: ${{ job.status }}
153 | check_id: ${{ steps.create-check.outputs.check-id }}
154 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: CI
4 |
5 | on:
6 | workflow_dispatch:
7 | pull_request:
8 | push:
9 | branches:
10 | - main
11 | schedule:
12 | # "At 09:00 UTC (02:00 PT) on Monday" https://crontab.guru/#0_9_*_*_1
13 | - cron: "0 9 * * 1"
14 |
15 | permissions:
16 | contents: read
17 |
18 | jobs:
19 | lint:
20 | name: Lint
21 | if: github.repository_owner == 'npm'
22 | runs-on: ubuntu-latest
23 | defaults:
24 | run:
25 | shell: bash
26 | steps:
27 | - name: Checkout
28 | uses: actions/checkout@v4
29 | - name: Setup Git User
30 | run: |
31 | git config --global user.email "npm-cli+bot@github.com"
32 | git config --global user.name "npm CLI robot"
33 | - name: Setup Node
34 | uses: actions/setup-node@v4
35 | id: node
36 | with:
37 | node-version: 22.x
38 | check-latest: contains('22.x', '.x')
39 | - name: Install Latest npm
40 | uses: ./.github/actions/install-latest-npm
41 | with:
42 | node: ${{ steps.node.outputs.node-version }}
43 | - name: Install Dependencies
44 | run: npm i --ignore-scripts --no-audit --no-fund
45 | - name: Lint
46 | run: npm run lint --ignore-scripts
47 | - name: Post Lint
48 | run: npm run postlint --ignore-scripts
49 |
50 | test:
51 | name: Test - ${{ matrix.platform.name }} - ${{ matrix.node-version }}
52 | if: github.repository_owner == 'npm'
53 | strategy:
54 | fail-fast: false
55 | matrix:
56 | platform:
57 | - name: Linux
58 | os: ubuntu-latest
59 | shell: bash
60 | - name: macOS
61 | os: macos-latest
62 | shell: bash
63 | - name: macOS
64 | os: macos-13
65 | shell: bash
66 | - name: Windows
67 | os: windows-latest
68 | shell: cmd
69 | node-version:
70 | - 18.17.0
71 | - 18.x
72 | - 20.5.0
73 | - 20.x
74 | - 22.x
75 | exclude:
76 | - platform: { name: macOS, os: macos-13, shell: bash }
77 | node-version: 18.17.0
78 | - platform: { name: macOS, os: macos-13, shell: bash }
79 | node-version: 18.x
80 | - platform: { name: macOS, os: macos-13, shell: bash }
81 | node-version: 20.5.0
82 | - platform: { name: macOS, os: macos-13, shell: bash }
83 | node-version: 20.x
84 | - platform: { name: macOS, os: macos-13, shell: bash }
85 | node-version: 22.x
86 | runs-on: ${{ matrix.platform.os }}
87 | defaults:
88 | run:
89 | shell: ${{ matrix.platform.shell }}
90 | steps:
91 | - name: Checkout
92 | uses: actions/checkout@v4
93 | - name: Setup Git User
94 | run: |
95 | git config --global user.email "npm-cli+bot@github.com"
96 | git config --global user.name "npm CLI robot"
97 | - name: Setup Node
98 | uses: actions/setup-node@v4
99 | id: node
100 | with:
101 | node-version: ${{ matrix.node-version }}
102 | check-latest: contains(matrix.node-version, '.x')
103 | - name: Install Latest npm
104 | uses: ./.github/actions/install-latest-npm
105 | with:
106 | node: ${{ steps.node.outputs.node-version }}
107 | - name: Install Dependencies
108 | run: npm i --ignore-scripts --no-audit --no-fund
109 | - name: Add Problem Matcher
110 | run: echo "::add-matcher::.github/matchers/tap.json"
111 | - name: Test
112 | run: npm test --ignore-scripts
113 |
--------------------------------------------------------------------------------
/.github/workflows/codeql-analysis.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: CodeQL
4 |
5 | on:
6 | push:
7 | branches:
8 | - main
9 | pull_request:
10 | branches:
11 | - main
12 | schedule:
13 | # "At 10:00 UTC (03:00 PT) on Monday" https://crontab.guru/#0_10_*_*_1
14 | - cron: "0 10 * * 1"
15 |
16 | permissions:
17 | contents: read
18 |
19 | jobs:
20 | analyze:
21 | name: Analyze
22 | runs-on: ubuntu-latest
23 | permissions:
24 | actions: read
25 | contents: read
26 | security-events: write
27 | steps:
28 | - name: Checkout
29 | uses: actions/checkout@v4
30 | - name: Setup Git User
31 | run: |
32 | git config --global user.email "npm-cli+bot@github.com"
33 | git config --global user.name "npm CLI robot"
34 | - name: Initialize CodeQL
35 | uses: github/codeql-action/init@v3
36 | with:
37 | languages: javascript
38 | - name: Perform CodeQL Analysis
39 | uses: github/codeql-action/analyze@v3
40 |
--------------------------------------------------------------------------------
/.github/workflows/post-dependabot.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Post Dependabot
4 |
5 | on: pull_request
6 |
7 | permissions:
8 | contents: write
9 |
10 | jobs:
11 | template-oss:
12 | name: template-oss
13 | if: github.repository_owner == 'npm' && github.actor == 'dependabot[bot]'
14 | runs-on: ubuntu-latest
15 | defaults:
16 | run:
17 | shell: bash
18 | steps:
19 | - name: Checkout
20 | uses: actions/checkout@v4
21 | with:
22 | ref: ${{ github.event.pull_request.head.ref }}
23 | - name: Setup Git User
24 | run: |
25 | git config --global user.email "npm-cli+bot@github.com"
26 | git config --global user.name "npm CLI robot"
27 | - name: Setup Node
28 | uses: actions/setup-node@v4
29 | id: node
30 | with:
31 | node-version: 22.x
32 | check-latest: contains('22.x', '.x')
33 | - name: Install Latest npm
34 | uses: ./.github/actions/install-latest-npm
35 | with:
36 | node: ${{ steps.node.outputs.node-version }}
37 | - name: Install Dependencies
38 | run: npm i --ignore-scripts --no-audit --no-fund
39 | - name: Fetch Dependabot Metadata
40 | id: metadata
41 | uses: dependabot/fetch-metadata@v1
42 | with:
43 | github-token: ${{ secrets.GITHUB_TOKEN }}
44 |
45 | # Dependabot can update multiple directories so we output which directory
46 | # it is acting on so we can run the command for the correct root or workspace
47 | - name: Get Dependabot Directory
48 | if: contains(steps.metadata.outputs.dependency-names, '@npmcli/template-oss')
49 | id: flags
50 | run: |
51 | dependabot_dir="${{ steps.metadata.outputs.directory }}"
52 | if [[ "$dependabot_dir" == "/" || "$dependabot_dir" == "/main" ]]; then
53 | echo "workspace=-iwr" >> $GITHUB_OUTPUT
54 | else
55 | # strip leading slash from directory so it works as a
56 | # a path to the workspace flag
57 | echo "workspace=-w ${dependabot_dir#/}" >> $GITHUB_OUTPUT
58 | fi
59 |
60 | - name: Apply Changes
61 | if: steps.flags.outputs.workspace
62 | id: apply
63 | run: |
64 | npm run template-oss-apply ${{ steps.flags.outputs.workspace }}
65 | if [[ `git status --porcelain` ]]; then
66 | echo "changes=true" >> $GITHUB_OUTPUT
67 | fi
68 | # This only sets the conventional commit prefix. This workflow can't reliably determine
69 | # what the breaking change is though. If a BREAKING CHANGE message is required then
70 | # this PR check will fail and the commit will be amended with stafftools
71 | if [[ "${{ steps.metadata.outputs.update-type }}" == "version-update:semver-major" ]]; then
72 | prefix='feat!'
73 | else
74 | prefix='chore'
75 | fi
76 | echo "message=$prefix: postinstall for dependabot template-oss PR" >> $GITHUB_OUTPUT
77 |
78 | # This step will fail if template-oss has made any workflow updates. It is impossible
79 | # for a workflow to update other workflows. In the case it does fail, we continue
80 | # and then try to apply only a portion of the changes in the next step
81 | - name: Push All Changes
82 | if: steps.apply.outputs.changes
83 | id: push
84 | continue-on-error: true
85 | env:
86 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87 | run: |
88 | git commit -am "${{ steps.apply.outputs.message }}"
89 | git push
90 |
91 | # If the previous step failed, then reset the commit and remove any workflow changes
92 | # and attempt to commit and push again. This is helpful because we will have a commit
93 | # with the correct prefix that we can then --amend with @npmcli/stafftools later.
94 | - name: Push All Changes Except Workflows
95 | if: steps.apply.outputs.changes && steps.push.outcome == 'failure'
96 | env:
97 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
98 | run: |
99 | git reset HEAD~
100 | git checkout HEAD -- .github/workflows/
101 | git clean -fd .github/workflows/
102 | git commit -am "${{ steps.apply.outputs.message }}"
103 | git push
104 |
105 | # Check if all the necessary template-oss changes were applied. Since we continued
106 | # on errors in one of the previous steps, this check will fail if our follow up
107 | # only applied a portion of the changes and we need to followup manually.
108 | #
109 | # Note that this used to run `lint` and `postlint` but that will fail this action
110 | # if we've also shipped any linting changes separate from template-oss. We do
111 | # linting in another action, so we want to fail this one only if there are
112 | # template-oss changes that could not be applied.
113 | - name: Check Changes
114 | if: steps.apply.outputs.changes
115 | run: |
116 | npm exec --offline ${{ steps.flags.outputs.workspace }} -- template-oss-check
117 |
118 | - name: Fail on Breaking Change
119 | if: steps.apply.outputs.changes && startsWith(steps.apply.outputs.message, 'feat!')
120 | run: |
121 | echo "This PR has a breaking change. Run 'npx -p @npmcli/stafftools gh template-oss-fix'"
122 | echo "for more information on how to fix this with a BREAKING CHANGE footer."
123 | exit 1
124 |
--------------------------------------------------------------------------------
/.github/workflows/pull-request.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Pull Request
4 |
5 | on:
6 | pull_request:
7 | types:
8 | - opened
9 | - reopened
10 | - edited
11 | - synchronize
12 |
13 | permissions:
14 | contents: read
15 |
16 | jobs:
17 | commitlint:
18 | name: Lint Commits
19 | if: github.repository_owner == 'npm'
20 | runs-on: ubuntu-latest
21 | defaults:
22 | run:
23 | shell: bash
24 | steps:
25 | - name: Checkout
26 | uses: actions/checkout@v4
27 | with:
28 | fetch-depth: 0
29 | - name: Setup Git User
30 | run: |
31 | git config --global user.email "npm-cli+bot@github.com"
32 | git config --global user.name "npm CLI robot"
33 | - name: Setup Node
34 | uses: actions/setup-node@v4
35 | id: node
36 | with:
37 | node-version: 22.x
38 | check-latest: contains('22.x', '.x')
39 | - name: Install Latest npm
40 | uses: ./.github/actions/install-latest-npm
41 | with:
42 | node: ${{ steps.node.outputs.node-version }}
43 | - name: Install Dependencies
44 | run: npm i --ignore-scripts --no-audit --no-fund
45 | - name: Run Commitlint on Commits
46 | id: commit
47 | continue-on-error: true
48 | run: npx --offline commitlint -V --from 'origin/${{ github.base_ref }}' --to ${{ github.event.pull_request.head.sha }}
49 | - name: Run Commitlint on PR Title
50 | if: steps.commit.outcome == 'failure'
51 | env:
52 | PR_TITLE: ${{ github.event.pull_request.title }}
53 | run: echo "$PR_TITLE" | npx --offline commitlint -V
54 |
--------------------------------------------------------------------------------
/.github/workflows/release-integration.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Release Integration
4 |
5 | on:
6 | workflow_dispatch:
7 | inputs:
8 | releases:
9 | required: true
10 | type: string
11 | description: 'A json array of releases. Required fields: publish: tagName, publishTag. publish check: pkgName, version'
12 | workflow_call:
13 | inputs:
14 | releases:
15 | required: true
16 | type: string
17 | description: 'A json array of releases. Required fields: publish: tagName, publishTag. publish check: pkgName, version'
18 | secrets:
19 | PUBLISH_TOKEN:
20 | required: true
21 |
22 | permissions:
23 | contents: read
24 | id-token: write
25 |
26 | jobs:
27 | publish:
28 | name: Publish
29 | runs-on: ubuntu-latest
30 | defaults:
31 | run:
32 | shell: bash
33 | permissions:
34 | id-token: write
35 | steps:
36 | - name: Checkout
37 | uses: actions/checkout@v4
38 | with:
39 | ref: ${{ fromJSON(inputs.releases)[0].tagName }}
40 | - name: Setup Git User
41 | run: |
42 | git config --global user.email "npm-cli+bot@github.com"
43 | git config --global user.name "npm CLI robot"
44 | - name: Setup Node
45 | uses: actions/setup-node@v4
46 | id: node
47 | with:
48 | node-version: 22.x
49 | check-latest: contains('22.x', '.x')
50 | - name: Install Latest npm
51 | uses: ./.github/actions/install-latest-npm
52 | with:
53 | node: ${{ steps.node.outputs.node-version }}
54 | - name: Install Dependencies
55 | run: npm i --ignore-scripts --no-audit --no-fund
56 | - name: Set npm authToken
57 | run: npm config set '//registry.npmjs.org/:_authToken'=\${PUBLISH_TOKEN}
58 | - name: Publish
59 | env:
60 | PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
61 | RELEASES: ${{ inputs.releases }}
62 | run: |
63 | EXIT_CODE=0
64 |
65 | for release in $(echo $RELEASES | jq -r '.[] | @base64'); do
66 | PUBLISH_TAG=$(echo "$release" | base64 --decode | jq -r .publishTag)
67 | npm publish --provenance --tag="$PUBLISH_TAG"
68 | STATUS=$?
69 | if [[ "$STATUS" -eq 1 ]]; then
70 | EXIT_CODE=$STATUS
71 | fi
72 | done
73 |
74 | exit $EXIT_CODE
75 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | name: Release
4 |
5 | on:
6 | push:
7 | branches:
8 | - main
9 |
10 | permissions:
11 | contents: write
12 | pull-requests: write
13 | checks: write
14 |
15 | jobs:
16 | release:
17 | outputs:
18 | pr: ${{ steps.release.outputs.pr }}
19 | pr-branch: ${{ steps.release.outputs.pr-branch }}
20 | pr-number: ${{ steps.release.outputs.pr-number }}
21 | pr-sha: ${{ steps.release.outputs.pr-sha }}
22 | releases: ${{ steps.release.outputs.releases }}
23 | comment-id: ${{ steps.create-comment.outputs.comment-id || steps.update-comment.outputs.comment-id }}
24 | check-id: ${{ steps.create-check.outputs.check-id }}
25 | name: Release
26 | if: github.repository_owner == 'npm'
27 | runs-on: ubuntu-latest
28 | defaults:
29 | run:
30 | shell: bash
31 | steps:
32 | - name: Checkout
33 | uses: actions/checkout@v4
34 | - name: Setup Git User
35 | run: |
36 | git config --global user.email "npm-cli+bot@github.com"
37 | git config --global user.name "npm CLI robot"
38 | - name: Setup Node
39 | uses: actions/setup-node@v4
40 | id: node
41 | with:
42 | node-version: 22.x
43 | check-latest: contains('22.x', '.x')
44 | - name: Install Latest npm
45 | uses: ./.github/actions/install-latest-npm
46 | with:
47 | node: ${{ steps.node.outputs.node-version }}
48 | - name: Install Dependencies
49 | run: npm i --ignore-scripts --no-audit --no-fund
50 | - name: Release Please
51 | id: release
52 | env:
53 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54 | run: npx --offline template-oss-release-please --branch="${{ github.ref_name }}" --backport="" --defaultTag="latest"
55 | - name: Create Release Manager Comment Text
56 | if: steps.release.outputs.pr-number
57 | uses: actions/github-script@v7
58 | id: comment-text
59 | with:
60 | result-encoding: string
61 | script: |
62 | const { runId, repo: { owner, repo } } = context
63 | const { data: workflow } = await github.rest.actions.getWorkflowRun({ owner, repo, run_id: runId })
64 | return['## Release Manager', `Release workflow run: ${workflow.html_url}`].join('\n\n')
65 | - name: Find Release Manager Comment
66 | uses: peter-evans/find-comment@v2
67 | if: steps.release.outputs.pr-number
68 | id: found-comment
69 | with:
70 | issue-number: ${{ steps.release.outputs.pr-number }}
71 | comment-author: 'github-actions[bot]'
72 | body-includes: '## Release Manager'
73 | - name: Create Release Manager Comment
74 | id: create-comment
75 | if: steps.release.outputs.pr-number && !steps.found-comment.outputs.comment-id
76 | uses: peter-evans/create-or-update-comment@v3
77 | with:
78 | issue-number: ${{ steps.release.outputs.pr-number }}
79 | body: ${{ steps.comment-text.outputs.result }}
80 | - name: Update Release Manager Comment
81 | id: update-comment
82 | if: steps.release.outputs.pr-number && steps.found-comment.outputs.comment-id
83 | uses: peter-evans/create-or-update-comment@v3
84 | with:
85 | comment-id: ${{ steps.found-comment.outputs.comment-id }}
86 | body: ${{ steps.comment-text.outputs.result }}
87 | edit-mode: 'replace'
88 | - name: Create Check
89 | id: create-check
90 | uses: ./.github/actions/create-check
91 | if: steps.release.outputs.pr-sha
92 | with:
93 | name: "Release"
94 | token: ${{ secrets.GITHUB_TOKEN }}
95 | sha: ${{ steps.release.outputs.pr-sha }}
96 |
97 | update:
98 | needs: release
99 | outputs:
100 | sha: ${{ steps.commit.outputs.sha }}
101 | check-id: ${{ steps.create-check.outputs.check-id }}
102 | name: Update - Release
103 | if: github.repository_owner == 'npm' && needs.release.outputs.pr
104 | runs-on: ubuntu-latest
105 | defaults:
106 | run:
107 | shell: bash
108 | steps:
109 | - name: Checkout
110 | uses: actions/checkout@v4
111 | with:
112 | fetch-depth: 0
113 | ref: ${{ needs.release.outputs.pr-branch }}
114 | - name: Setup Git User
115 | run: |
116 | git config --global user.email "npm-cli+bot@github.com"
117 | git config --global user.name "npm CLI robot"
118 | - name: Setup Node
119 | uses: actions/setup-node@v4
120 | id: node
121 | with:
122 | node-version: 22.x
123 | check-latest: contains('22.x', '.x')
124 | - name: Install Latest npm
125 | uses: ./.github/actions/install-latest-npm
126 | with:
127 | node: ${{ steps.node.outputs.node-version }}
128 | - name: Install Dependencies
129 | run: npm i --ignore-scripts --no-audit --no-fund
130 | - name: Create Release Manager Checklist Text
131 | id: comment-text
132 | env:
133 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
134 | run: npm exec --offline -- template-oss-release-manager --pr="${{ needs.release.outputs.pr-number }}" --backport="" --defaultTag="latest" --publish
135 | - name: Append Release Manager Comment
136 | uses: peter-evans/create-or-update-comment@v3
137 | with:
138 | comment-id: ${{ needs.release.outputs.comment-id }}
139 | body: ${{ steps.comment-text.outputs.result }}
140 | edit-mode: 'append'
141 | - name: Run Post Pull Request Actions
142 | env:
143 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
144 | run: npm run rp-pull-request --ignore-scripts --if-present -- --pr="${{ needs.release.outputs.pr-number }}" --commentId="${{ needs.release.outputs.comment-id }}"
145 | - name: Commit
146 | id: commit
147 | env:
148 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
149 | run: |
150 | git commit --all --amend --no-edit || true
151 | git push --force-with-lease
152 | echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
153 | - name: Create Check
154 | id: create-check
155 | uses: ./.github/actions/create-check
156 | with:
157 | name: "Update - Release"
158 | check-name: "Release"
159 | token: ${{ secrets.GITHUB_TOKEN }}
160 | sha: ${{ steps.commit.outputs.sha }}
161 | - name: Conclude Check
162 | uses: LouisBrunner/checks-action@v1.6.0
163 | with:
164 | token: ${{ secrets.GITHUB_TOKEN }}
165 | conclusion: ${{ job.status }}
166 | check_id: ${{ needs.release.outputs.check-id }}
167 |
168 | ci:
169 | name: CI - Release
170 | needs: [ release, update ]
171 | if: needs.release.outputs.pr
172 | uses: ./.github/workflows/ci-release.yml
173 | with:
174 | ref: ${{ needs.release.outputs.pr-branch }}
175 | check-sha: ${{ needs.update.outputs.sha }}
176 |
177 | post-ci:
178 | needs: [ release, update, ci ]
179 | name: Post CI - Release
180 | if: github.repository_owner == 'npm' && needs.release.outputs.pr && always()
181 | runs-on: ubuntu-latest
182 | defaults:
183 | run:
184 | shell: bash
185 | steps:
186 | - name: Get CI Conclusion
187 | id: conclusion
188 | run: |
189 | result=""
190 | if [[ "${{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
191 | result="failure"
192 | elif [[ "${{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
193 | result="cancelled"
194 | else
195 | result="success"
196 | fi
197 | echo "result=$result" >> $GITHUB_OUTPUT
198 | - name: Conclude Check
199 | uses: LouisBrunner/checks-action@v1.6.0
200 | with:
201 | token: ${{ secrets.GITHUB_TOKEN }}
202 | conclusion: ${{ steps.conclusion.outputs.result }}
203 | check_id: ${{ needs.update.outputs.check-id }}
204 |
205 | post-release:
206 | needs: release
207 | outputs:
208 | comment-id: ${{ steps.create-comment.outputs.comment-id }}
209 | name: Post Release - Release
210 | if: github.repository_owner == 'npm' && needs.release.outputs.releases
211 | runs-on: ubuntu-latest
212 | defaults:
213 | run:
214 | shell: bash
215 | steps:
216 | - name: Create Release PR Comment Text
217 | id: comment-text
218 | uses: actions/github-script@v7
219 | env:
220 | RELEASES: ${{ needs.release.outputs.releases }}
221 | with:
222 | result-encoding: string
223 | script: |
224 | const releases = JSON.parse(process.env.RELEASES)
225 | const { runId, repo: { owner, repo } } = context
226 | const issue_number = releases[0].prNumber
227 | const runUrl = `https://github.com/${owner}/${repo}/actions/runs/${runId}`
228 |
229 | return [
230 | '## Release Workflow\n',
231 | ...releases.map(r => `- \`${r.pkgName}@${r.version}\` ${r.url}`),
232 | `- Workflow run: :arrows_counterclockwise: ${runUrl}`,
233 | ].join('\n')
234 | - name: Create Release PR Comment
235 | id: create-comment
236 | uses: peter-evans/create-or-update-comment@v3
237 | with:
238 | issue-number: ${{ fromJSON(needs.release.outputs.releases)[0].prNumber }}
239 | body: ${{ steps.comment-text.outputs.result }}
240 |
241 | release-integration:
242 | needs: release
243 | name: Release Integration
244 | if: needs.release.outputs.releases
245 | uses: ./.github/workflows/release-integration.yml
246 | permissions:
247 | contents: read
248 | id-token: write
249 | secrets:
250 | PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
251 | with:
252 | releases: ${{ needs.release.outputs.releases }}
253 |
254 | post-release-integration:
255 | needs: [ release, release-integration, post-release ]
256 | name: Post Release Integration - Release
257 | if: github.repository_owner == 'npm' && needs.release.outputs.releases && always()
258 | runs-on: ubuntu-latest
259 | defaults:
260 | run:
261 | shell: bash
262 | steps:
263 | - name: Get Post Release Conclusion
264 | id: conclusion
265 | run: |
266 | if [[ "${{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
267 | result="x"
268 | elif [[ "${{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
269 | result="heavy_multiplication_x"
270 | else
271 | result="white_check_mark"
272 | fi
273 | echo "result=$result" >> $GITHUB_OUTPUT
274 | - name: Find Release PR Comment
275 | uses: peter-evans/find-comment@v2
276 | id: found-comment
277 | with:
278 | issue-number: ${{ fromJSON(needs.release.outputs.releases)[0].prNumber }}
279 | comment-author: 'github-actions[bot]'
280 | body-includes: '## Release Workflow'
281 | - name: Create Release PR Comment Text
282 | id: comment-text
283 | if: steps.found-comment.outputs.comment-id
284 | uses: actions/github-script@v7
285 | env:
286 | RESULT: ${{ steps.conclusion.outputs.result }}
287 | BODY: ${{ steps.found-comment.outputs.comment-body }}
288 | with:
289 | result-encoding: string
290 | script: |
291 | const { RESULT, BODY } = process.env
292 | const body = [BODY.replace(/(Workflow run: :)[a-z_]+(:)/, `$1${RESULT}$2`)]
293 | if (RESULT !== 'white_check_mark') {
294 | body.push(':rotating_light::rotating_light::rotating_light:')
295 | body.push([
296 | '@npm/cli-team: The post-release workflow failed for this release.',
297 | 'Manual steps may need to be taken after examining the workflow output.'
298 | ].join(' '))
299 | body.push(':rotating_light::rotating_light::rotating_light:')
300 | }
301 | return body.join('\n\n').trim()
302 | - name: Update Release PR Comment
303 | if: steps.comment-text.outputs.result
304 | uses: peter-evans/create-or-update-comment@v3
305 | with:
306 | comment-id: ${{ steps.found-comment.outputs.comment-id }}
307 | body: ${{ steps.comment-text.outputs.result }}
308 | edit-mode: 'replace'
309 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | # ignore everything in the root
4 | /*
5 |
6 | !**/.gitignore
7 | !/.commitlintrc.js
8 | !/.eslint.config.js
9 | !/.eslintrc.js
10 | !/.eslintrc.local.*
11 | !/.git-blame-ignore-revs
12 | !/.github/
13 | !/.gitignore
14 | !/.npmrc
15 | !/.prettierignore
16 | !/.prettierrc.js
17 | !/.release-please-manifest.json
18 | !/bin/
19 | !/CHANGELOG*
20 | !/CODE_OF_CONDUCT.md
21 | !/CONTRIBUTING.md
22 | !/docs/
23 | !/lib/
24 | !/LICENSE*
25 | !/map.js
26 | !/package.json
27 | !/README*
28 | !/release-please-config.json
29 | !/scripts/
30 | !/SECURITY.md
31 | !/tap-snapshots/
32 | !/test/
33 | !/tsconfig.json
34 | tap-testdir*/
35 |
--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | ; This file is automatically added by @npmcli/template-oss. Do not edit.
2 |
3 | package-lock=false
4 |
--------------------------------------------------------------------------------
/.release-please-manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | ".": "2.0.0"
3 | }
4 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## [2.0.0](https://github.com/npm/mute-stream/compare/v1.0.0...v2.0.0) (2024-09-24)
4 | ### ⚠️ BREAKING CHANGES
5 | * `mute-stream` now supports node `^18.17.0 || >=20.5.0`
6 | ### Bug Fixes
7 | * [`618a475`](https://github.com/npm/mute-stream/commit/618a475080965ca94f4b3451b0183ba30b63e7ea) [#83](https://github.com/npm/mute-stream/pull/83) align to npm 10 node engine range (@hashtagchris)
8 | ### Chores
9 | * [`8550977`](https://github.com/npm/mute-stream/commit/8550977e63b6ae4774ea79375643568a87192add) [#85](https://github.com/npm/mute-stream/pull/85) enable auto publish (#85) (@reggi)
10 | * [`7290739`](https://github.com/npm/mute-stream/commit/7290739010a36229107662341ac698a1ef531277) [#83](https://github.com/npm/mute-stream/pull/83) run template-oss-apply (@hashtagchris)
11 | * [`f7c34f1`](https://github.com/npm/mute-stream/commit/f7c34f178a23ecef1be0e85c01da43e5a31fc17a) [#81](https://github.com/npm/mute-stream/pull/81) Bump @npmcli/eslint-config from 4.0.5 to 5.0.0 (@dependabot[bot])
12 | * [`4a0a0e1`](https://github.com/npm/mute-stream/commit/4a0a0e1c5d94ccbe9c508286b0131f6f44b7078e) [#82](https://github.com/npm/mute-stream/pull/82) Bump @npmcli/template-oss from 4.23.1 to 4.23.3 (@dependabot[bot])
13 | * [`5c71213`](https://github.com/npm/mute-stream/commit/5c71213b82d6eaaae54d2e759987dea3c9ccb319) [#79](https://github.com/npm/mute-stream/pull/79) Bump @npmcli/template-oss from 4.22.0 to 4.23.1 (@dependabot[bot])
14 | * [`28ed532`](https://github.com/npm/mute-stream/commit/28ed532a787f31b327f5227a8d01dc822e9af18f) [#70](https://github.com/npm/mute-stream/pull/70) bump @npmcli/template-oss to 4.22.0 (@lukekarrys)
15 | * [`bfce761`](https://github.com/npm/mute-stream/commit/bfce7610fc91d8f30e920a7d6922daa6267704df) [#69](https://github.com/npm/mute-stream/pull/69) Bump @npmcli/template-oss from 4.21.3 to 4.21.4 (@dependabot[bot])
16 | * [`563f5a9`](https://github.com/npm/mute-stream/commit/563f5a93619c767832aae103740fef304787686f) [#65](https://github.com/npm/mute-stream/pull/65) Bump @npmcli/template-oss from 4.21.1 to 4.21.3 (@dependabot[bot])
17 | * [`e8378c7`](https://github.com/npm/mute-stream/commit/e8378c7babb44b39eb20cd3a9df91483c784ace4) [#62](https://github.com/npm/mute-stream/pull/62) Bump @npmcli/template-oss from 4.19.0 to 4.21.1 (@dependabot[bot])
18 | * [`fb2cc45`](https://github.com/npm/mute-stream/commit/fb2cc4583304eeb7bc1c5fbdb80f434902bf6021) [#43](https://github.com/npm/mute-stream/pull/43) Bump @npmcli/template-oss from 4.18.1 to 4.19.0 (@dependabot[bot])
19 | * [`bfdb357`](https://github.com/npm/mute-stream/commit/bfdb3571c5f455d424a2e3fa9a5ce673615a8c03) [#42](https://github.com/npm/mute-stream/pull/42) Bump @npmcli/template-oss from 4.18.0 to 4.18.1 (@dependabot[bot])
20 | * [`9d8a006`](https://github.com/npm/mute-stream/commit/9d8a006606bcb1e7de7b65bc9f4b2cf80d152df3) [#41](https://github.com/npm/mute-stream/pull/41) Bump @npmcli/template-oss from 4.17.0 to 4.18.0 (@dependabot[bot])
21 | * [`7262cbb`](https://github.com/npm/mute-stream/commit/7262cbb5ba46d6dce8611ac64ba70878b84b497c) [#40](https://github.com/npm/mute-stream/pull/40) Bump @npmcli/template-oss from 4.15.1 to 4.17.0 (@dependabot[bot])
22 | * [`e937e09`](https://github.com/npm/mute-stream/commit/e937e098b1a132d0fd1a234d4273c551db4a5fc0) [#39](https://github.com/npm/mute-stream/pull/39) Bump @npmcli/template-oss from 4.14.1 to 4.15.1 (@dependabot[bot])
23 | * [`680314a`](https://github.com/npm/mute-stream/commit/680314a7391cf136788b4b3de9f4e2c2f3d5f068) [#38](https://github.com/npm/mute-stream/pull/38) Bump @npmcli/template-oss from 4.13.0 to 4.14.1 (#38) (@dependabot[bot], @npm-cli-bot)
24 | * [`af0ab95`](https://github.com/npm/mute-stream/commit/af0ab953a5368f5fc84c3622bd43585b1e1b5a2b) [#36](https://github.com/npm/mute-stream/pull/36) Bump @npmcli/template-oss from 4.12.1 to 4.13.0 (#36) (@dependabot[bot], @npm-cli-bot, @nlf)
25 | * [`c409b8b`](https://github.com/npm/mute-stream/commit/c409b8b2e90b1bbdbba64698c6818e1e6a25936d) [#37](https://github.com/npm/mute-stream/pull/37) minor readme update (#37) (@nlf)
26 | * [`11453d7`](https://github.com/npm/mute-stream/commit/11453d7d0c883ae96cf0ea80b80771d48c69b657) [#35](https://github.com/npm/mute-stream/pull/35) Bump @npmcli/template-oss from 4.12.0 to 4.12.1 (#35) (@dependabot[bot], @npm-cli-bot)
27 | * [`28e1f16`](https://github.com/npm/mute-stream/commit/28e1f16205ffb6c03ba8774cd19a9eba971a3ca5) [#34](https://github.com/npm/mute-stream/pull/34) Bump @npmcli/template-oss from 4.11.4 to 4.12.0 (@dependabot[bot])
28 | * [`fcd2267`](https://github.com/npm/mute-stream/commit/fcd2267576d2fa341b6549a35eb311b0534e34da) [#33](https://github.com/npm/mute-stream/pull/33) Bump @npmcli/template-oss from 4.11.3 to 4.11.4 (@dependabot[bot])
29 | * [`6e43e36`](https://github.com/npm/mute-stream/commit/6e43e360e57cf0d9a9aa48ec718bf1b6dea7748e) [#32](https://github.com/npm/mute-stream/pull/32) Bump @npmcli/template-oss from 4.11.0 to 4.11.3 (@dependabot[bot])
30 | * [`1bc3d48`](https://github.com/npm/mute-stream/commit/1bc3d48b7545ba35cfd2760420def9629528fd64) [#82](https://github.com/npm/mute-stream/pull/82) postinstall for dependabot template-oss PR (@hashtagchris)
31 |
32 | ## [1.0.0](https://github.com/npm/mute-stream/compare/v0.0.8...v1.0.0) (2022-12-12)
33 |
34 | ### ⚠️ BREAKING CHANGES
35 |
36 | * this package is now compatible with the following semver range for node: `^14.17.0 || ^16.13.0 || >=18.0.0`
37 |
38 | ### Features
39 |
40 | * [`bb1e248`](https://github.com/npm/mute-stream/commit/bb1e24845a1d8c7ec3c3a2950cf7a4e8d5c46be2) add template-oss (@lukekarrys)
41 |
42 | ### Bug Fixes
43 |
44 | * [`72b4956`](https://github.com/npm/mute-stream/commit/72b4956049769b99305b8934ec5448ab4184181f) replace substr with slice (@lukekarrys)
45 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | All interactions in this repo are covered by the [npm Code of
4 | Conduct](https://docs.npmjs.com/policies/conduct)
5 |
6 | The npm cli team may, at its own discretion, moderate, remove, or edit
7 | any interactions such as pull requests, issues, and comments.
8 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # Contributing
4 |
5 | ## Code of Conduct
6 |
7 | All interactions in the **npm** organization on GitHub are considered to be covered by our standard [Code of Conduct](https://docs.npmjs.com/policies/conduct).
8 |
9 | ## Reporting Bugs
10 |
11 | Before submitting a new bug report please search for an existing or similar report.
12 |
13 | Use one of our existing issue templates if you believe you've come across a unique problem.
14 |
15 | Duplicate issues, or issues that don't use one of our templates may get closed without a response.
16 |
17 | ## Pull Request Conventions
18 |
19 | ### Commits
20 |
21 | We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
22 |
23 | When opening a pull request please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:
24 |
25 | - `feat`: For when introducing a new feature. The result will be a new semver minor version of the package when it is next published.
26 | - `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published.
27 | - `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published.
28 | - `chore`: For changes that do not affect the published module. Often these are changes to tests. The result will be *no* change to the version of the package when it is next published (as the commit does not affect the published version).
29 |
30 | ### Test Coverage
31 |
32 | Pull requests made against this repo will run `npm test` automatically. Please make sure tests pass locally before submitting a PR.
33 |
34 | Every new feature or bug fix should come with a corresponding test or tests that validate the solutions. Testing also reports on code coverage and will fail if code coverage drops.
35 |
36 | ### Linting
37 |
38 | Linting is also done automatically once tests pass. `npm run lintfix` will fix most linting errors automatically.
39 |
40 | Please make sure linting passes before submitting a PR.
41 |
42 | ## What _not_ to contribute?
43 |
44 | ### Dependencies
45 |
46 | It should be noted that our team does not accept third-party dependency updates/PRs. If you submit a PR trying to update our dependencies we will close it with or without a reference to these contribution guidelines.
47 |
48 | ### Tools/Automation
49 |
50 | Our core team is responsible for the maintenance of the tooling/automation in this project and we ask contributors to not make changes to these when contributing (e.g. `.github/*`, `.eslintrc.json`, `.licensee.json`). Most of those files also have a header at the top to remind folks they are automatically generated. Pull requests that alter these will not be accepted.
51 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The ISC License
2 |
3 | Copyright (c) Isaac Z. Schlueter and Contributors
4 |
5 | Permission to use, copy, modify, and/or distribute this software for any
6 | purpose with or without fee is hereby granted, provided that the above
7 | copyright notice and this permission notice appear in all copies.
8 |
9 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
15 | IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # mute-stream
2 |
3 | Bytes go in, but they don't come out (when muted).
4 |
5 | This is a basic pass-through stream, but when muted, the bytes are
6 | silently dropped, rather than being passed through.
7 |
8 | ## Usage
9 |
10 | ```javascript
11 | const MuteStream = require('mute-stream')
12 |
13 | const ms = new MuteStream(options)
14 |
15 | ms.pipe(process.stdout)
16 | ms.write('foo') // writes 'foo' to stdout
17 | ms.mute()
18 | ms.write('bar') // does not write 'bar'
19 | ms.unmute()
20 | ms.write('baz') // writes 'baz' to stdout
21 |
22 | // can also be used to mute incoming data
23 | const ms = new MuteStream()
24 | input.pipe(ms)
25 |
26 | ms.on('data', function (c) {
27 | console.log('data: ' + c)
28 | })
29 |
30 | input.emit('data', 'foo') // logs 'foo'
31 | ms.mute()
32 | input.emit('data', 'bar') // does not log 'bar'
33 | ms.unmute()
34 | input.emit('data', 'baz') // logs 'baz'
35 | ```
36 |
37 | ## Options
38 |
39 | All options are optional.
40 |
41 | * `replace` Set to a string to replace each character with the
42 | specified string when muted. (So you can show `****` instead of the
43 | password, for example.)
44 |
45 | * `prompt` If you are using a replacement char, and also using a
46 | prompt with a readline stream (as for a `Password: *****` input),
47 | then specify what the prompt is so that backspace will work
48 | properly. Otherwise, pressing backspace will overwrite the prompt
49 | with the replacement character, which is weird.
50 |
51 | ## ms.mute()
52 |
53 | Set `muted` to `true`. Turns `.write()` into a no-op.
54 |
55 | ## ms.unmute()
56 |
57 | Set `muted` to `false`
58 |
59 | ## ms.isTTY
60 |
61 | True if the pipe destination is a TTY, or if the incoming pipe source is
62 | a TTY.
63 |
64 | ## Other stream methods...
65 |
66 | The other standard readable and writable stream methods are all
67 | available. The MuteStream object acts as a facade to its pipe source
68 | and destination.
69 |
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | GitHub takes the security of our software products and services seriously, including the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
4 |
5 | If you believe you have found a security vulnerability in this GitHub-owned open source repository, you can report it to us in one of two ways.
6 |
7 | If the vulnerability you have found is *not* [in scope for the GitHub Bug Bounty Program](https://bounty.github.com/#scope) or if you do not wish to be considered for a bounty reward, please report the issue to us directly through [opensource-security@github.com](mailto:opensource-security@github.com).
8 |
9 | If the vulnerability you have found is [in scope for the GitHub Bug Bounty Program](https://bounty.github.com/#scope) and you would like for your finding to be considered for a bounty reward, please submit the vulnerability to us through [HackerOne](https://hackerone.com/github) in order to be eligible to receive a bounty award.
10 |
11 | **Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
12 |
13 | Thanks for helping make GitHub safe for everyone.
14 |
--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
1 | const Stream = require('stream')
2 |
3 | class MuteStream extends Stream {
4 | #isTTY = null
5 |
6 | constructor (opts = {}) {
7 | super(opts)
8 | this.writable = this.readable = true
9 | this.muted = false
10 | this.on('pipe', this._onpipe)
11 | this.replace = opts.replace
12 |
13 | // For readline-type situations
14 | // This much at the start of a line being redrawn after a ctrl char
15 | // is seen (such as backspace) won't be redrawn as the replacement
16 | this._prompt = opts.prompt || null
17 | this._hadControl = false
18 | }
19 |
20 | #destSrc (key, def) {
21 | if (this._dest) {
22 | return this._dest[key]
23 | }
24 | if (this._src) {
25 | return this._src[key]
26 | }
27 | return def
28 | }
29 |
30 | #proxy (method, ...args) {
31 | if (typeof this._dest?.[method] === 'function') {
32 | this._dest[method](...args)
33 | }
34 | if (typeof this._src?.[method] === 'function') {
35 | this._src[method](...args)
36 | }
37 | }
38 |
39 | get isTTY () {
40 | if (this.#isTTY !== null) {
41 | return this.#isTTY
42 | }
43 | return this.#destSrc('isTTY', false)
44 | }
45 |
46 | // basically just get replace the getter/setter with a regular value
47 | set isTTY (val) {
48 | this.#isTTY = val
49 | }
50 |
51 | get rows () {
52 | return this.#destSrc('rows')
53 | }
54 |
55 | get columns () {
56 | return this.#destSrc('columns')
57 | }
58 |
59 | mute () {
60 | this.muted = true
61 | }
62 |
63 | unmute () {
64 | this.muted = false
65 | }
66 |
67 | _onpipe (src) {
68 | this._src = src
69 | }
70 |
71 | pipe (dest, options) {
72 | this._dest = dest
73 | return super.pipe(dest, options)
74 | }
75 |
76 | pause () {
77 | if (this._src) {
78 | return this._src.pause()
79 | }
80 | }
81 |
82 | resume () {
83 | if (this._src) {
84 | return this._src.resume()
85 | }
86 | }
87 |
88 | write (c) {
89 | if (this.muted) {
90 | if (!this.replace) {
91 | return true
92 | }
93 | // eslint-disable-next-line no-control-regex
94 | if (c.match(/^\u001b/)) {
95 | if (c.indexOf(this._prompt) === 0) {
96 | c = c.slice(this._prompt.length)
97 | c = c.replace(/./g, this.replace)
98 | c = this._prompt + c
99 | }
100 | this._hadControl = true
101 | return this.emit('data', c)
102 | } else {
103 | if (this._prompt && this._hadControl &&
104 | c.indexOf(this._prompt) === 0) {
105 | this._hadControl = false
106 | this.emit('data', this._prompt)
107 | c = c.slice(this._prompt.length)
108 | }
109 | c = c.toString().replace(/./g, this.replace)
110 | }
111 | }
112 | this.emit('data', c)
113 | }
114 |
115 | end (c) {
116 | if (this.muted) {
117 | if (c && this.replace) {
118 | c = c.toString().replace(/./g, this.replace)
119 | } else {
120 | c = null
121 | }
122 | }
123 | if (c) {
124 | this.emit('data', c)
125 | }
126 | this.emit('end')
127 | }
128 |
129 | destroy (...args) {
130 | return this.#proxy('destroy', ...args)
131 | }
132 |
133 | destroySoon (...args) {
134 | return this.#proxy('destroySoon', ...args)
135 | }
136 |
137 | close (...args) {
138 | return this.#proxy('close', ...args)
139 | }
140 | }
141 |
142 | module.exports = MuteStream
143 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "mute-stream",
3 | "version": "2.0.0",
4 | "main": "lib/index.js",
5 | "devDependencies": {
6 | "@npmcli/eslint-config": "^5.0.0",
7 | "@npmcli/template-oss": "4.24.3",
8 | "tap": "^16.3.0"
9 | },
10 | "scripts": {
11 | "test": "tap",
12 | "lint": "npm run eslint",
13 | "postlint": "template-oss-check",
14 | "template-oss-apply": "template-oss-apply --force",
15 | "lintfix": "npm run eslint -- --fix",
16 | "snap": "tap",
17 | "posttest": "npm run lint",
18 | "eslint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\""
19 | },
20 | "repository": {
21 | "type": "git",
22 | "url": "git+https://github.com/npm/mute-stream.git"
23 | },
24 | "keywords": [
25 | "mute",
26 | "stream",
27 | "pipe"
28 | ],
29 | "author": "GitHub Inc.",
30 | "license": "ISC",
31 | "description": "Bytes go in, but they don't come out (when muted).",
32 | "files": [
33 | "bin/",
34 | "lib/"
35 | ],
36 | "tap": {
37 | "statements": 70,
38 | "branches": 60,
39 | "functions": 81,
40 | "lines": 70,
41 | "nyc-arg": [
42 | "--exclude",
43 | "tap-snapshots/**"
44 | ]
45 | },
46 | "engines": {
47 | "node": "^18.17.0 || >=20.5.0"
48 | },
49 | "templateOSS": {
50 | "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
51 | "version": "4.24.3",
52 | "publish": true
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/release-please-config.json:
--------------------------------------------------------------------------------
1 | {
2 | "group-pull-request-title-pattern": "chore: release ${version}",
3 | "pull-request-title-pattern": "chore: release${component} ${version}",
4 | "changelog-sections": [
5 | {
6 | "type": "feat",
7 | "section": "Features",
8 | "hidden": false
9 | },
10 | {
11 | "type": "fix",
12 | "section": "Bug Fixes",
13 | "hidden": false
14 | },
15 | {
16 | "type": "docs",
17 | "section": "Documentation",
18 | "hidden": false
19 | },
20 | {
21 | "type": "deps",
22 | "section": "Dependencies",
23 | "hidden": false
24 | },
25 | {
26 | "type": "chore",
27 | "section": "Chores",
28 | "hidden": true
29 | }
30 | ],
31 | "packages": {
32 | ".": {
33 | "package-name": ""
34 | }
35 | },
36 | "prerelease-type": "pre.0"
37 | }
38 |
--------------------------------------------------------------------------------
/test/basic.js:
--------------------------------------------------------------------------------
1 | const Stream = require('stream')
2 | const tap = require('tap')
3 | const MS = require('../')
4 |
5 | // some marker objects
6 | var END = {}
7 | var PAUSE = {}
8 | var RESUME = {}
9 |
10 | class PassThrough extends Stream {
11 | constructor (opts) {
12 | super(opts)
13 | this.readable = this.writable = true
14 | }
15 |
16 | write (c) {
17 | this.emit('data', c)
18 | return true
19 | }
20 |
21 | end (c) {
22 | if (c) {
23 | this.write(c)
24 | }
25 | this.emit('end')
26 | }
27 |
28 | pause () {
29 | this.emit('pause')
30 | }
31 |
32 | resume () {
33 | this.emit('resume')
34 | }
35 | }
36 |
37 | tap.test('incoming', function (t) {
38 | var ms = new MS()
39 | var str = new PassThrough()
40 | str.pipe(ms)
41 |
42 | var expect = ['foo', 'boo', END]
43 | ms.on('data', function (c) {
44 | t.equal(c, expect.shift())
45 | })
46 | ms.on('end', function () {
47 | t.equal(END, expect.shift())
48 | t.end()
49 | })
50 | str.write('foo')
51 | ms.mute()
52 | str.write('bar')
53 | ms.unmute()
54 | str.write('boo')
55 | ms.mute()
56 | str.write('blaz')
57 | str.end('grelb')
58 | })
59 |
60 | tap.test('outgoing', function (t) {
61 | var ms = new MS()
62 | var str = new PassThrough()
63 | ms.pipe(str)
64 |
65 | var expect = ['foo', 'boo', END]
66 | str.on('data', function (c) {
67 | t.equal(c, expect.shift())
68 | })
69 | str.on('end', function () {
70 | t.equal(END, expect.shift())
71 | t.end()
72 | })
73 |
74 | ms.write('foo')
75 | ms.mute()
76 | ms.write('bar')
77 | ms.unmute()
78 | ms.write('boo')
79 | ms.mute()
80 | ms.write('blaz')
81 | ms.end('grelb')
82 | })
83 |
84 | tap.test('isTTY', function (t) {
85 | var str = new PassThrough()
86 | str.isTTY = true
87 | str.columns = 80
88 | str.rows = 24
89 |
90 | var ms = new MS()
91 | t.equal(ms.isTTY, false)
92 | t.equal(ms.columns, undefined)
93 | t.equal(ms.rows, undefined)
94 | ms.pipe(str)
95 | t.equal(ms.isTTY, true)
96 | t.equal(ms.columns, 80)
97 | t.equal(ms.rows, 24)
98 | str.isTTY = false
99 | t.equal(ms.isTTY, false)
100 | t.equal(ms.columns, 80)
101 | t.equal(ms.rows, 24)
102 | str.isTTY = true
103 | t.equal(ms.isTTY, true)
104 | t.equal(ms.columns, 80)
105 | t.equal(ms.rows, 24)
106 | ms.isTTY = false
107 | t.equal(ms.isTTY, false)
108 | t.equal(ms.columns, 80)
109 | t.equal(ms.rows, 24)
110 |
111 | ms = new MS()
112 | t.equal(ms.isTTY, false)
113 | str.pipe(ms)
114 | t.equal(ms.isTTY, true)
115 | str.isTTY = false
116 | t.equal(ms.isTTY, false)
117 | str.isTTY = true
118 | t.equal(ms.isTTY, true)
119 | ms.isTTY = false
120 | t.equal(ms.isTTY, false)
121 |
122 | t.end()
123 | })
124 |
125 | tap.test('pause/resume incoming', function (t) {
126 | var str = new PassThrough()
127 | var ms = new MS()
128 | str.on('pause', function () {
129 | t.equal(PAUSE, expect.shift())
130 | })
131 | str.on('resume', function () {
132 | t.equal(RESUME, expect.shift())
133 | })
134 | var expect = [PAUSE, RESUME, PAUSE, RESUME]
135 | str.pipe(ms)
136 | ms.pause()
137 | ms.resume()
138 | ms.pause()
139 | ms.resume()
140 | t.equal(expect.length, 0, 'saw all events')
141 | t.end()
142 | })
143 |
144 | tap.test('replace with *', function (t) {
145 | var str = new PassThrough()
146 | var ms = new MS({ replace: '*' })
147 | str.pipe(ms)
148 | var expect = ['foo', '*****', 'bar', '***', 'baz', 'boo', '**', '****']
149 |
150 | ms.on('data', function (c) {
151 | t.equal(c, expect.shift())
152 | })
153 |
154 | str.write('foo')
155 | ms.mute()
156 | str.write('12345')
157 | ms.unmute()
158 | str.write('bar')
159 | ms.mute()
160 | str.write('baz')
161 | ms.unmute()
162 | str.write('baz')
163 | str.write('boo')
164 | ms.mute()
165 | str.write('xy')
166 | str.write('xyzΩ')
167 |
168 | t.equal(expect.length, 0)
169 | t.end()
170 | })
171 |
172 | tap.test('replace with ~YARG~', function (t) {
173 | var str = new PassThrough()
174 | var ms = new MS({ replace: '~YARG~' })
175 | str.pipe(ms)
176 | var expect = ['foo', '~YARG~~YARG~~YARG~~YARG~~YARG~', 'bar',
177 | '~YARG~~YARG~~YARG~', 'baz', 'boo', '~YARG~~YARG~',
178 | '~YARG~~YARG~~YARG~~YARG~']
179 |
180 | ms.on('data', function (c) {
181 | t.equal(c, expect.shift())
182 | })
183 |
184 | // also throw some unicode in there, just for good measure.
185 | str.write('foo')
186 | ms.mute()
187 | str.write('ΩΩ')
188 | ms.unmute()
189 | str.write('bar')
190 | ms.mute()
191 | str.write('Ω')
192 | ms.unmute()
193 | str.write('baz')
194 | str.write('boo')
195 | ms.mute()
196 | str.write('Ω')
197 | str.write('ΩΩ')
198 |
199 | t.equal(expect.length, 0)
200 | t.end()
201 | })
202 |
--------------------------------------------------------------------------------