.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.github/funding.yml

@@ -0,0 +1,2 @@
+github: [sindresorhus, Qix-]
+tidelift: npm/ansi-regex

.github/security.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 14
+          - 12
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

fixtures/ansi-codes.js

@@ -1,7 +1,5 @@
-'use strict';
-
 // From http://www.umich.edu/~archive/apple2/misc/programmers/vt100.codes.txt
-exports.vt52Codes = new Map([
+export const vt52Codes = new Map([
 	['A', ['Cursor up']],
 	['B', ['Cursor down']],
 	['C', ['Cursor right']],
@@ -10,6 +8,8 @@ exports.vt52Codes = new Map([
 	['I', ['Reverse line feed']],
 	['J', ['Erase to end of screen']],
 	['K', ['Erase to end of line']],
+	['S', ['Scroll up']],
+	['T', ['Scroll down']],
 	['Z', ['Identify']],
 	['=', ['Enter alternate keypad mode']],
 	['>', ['Exit alternate keypad mode']],
@@ -19,7 +19,7 @@ exports.vt52Codes = new Map([
 ]);
 
 // From http://www.umich.edu/~archive/apple2/misc/programmers/vt100.codes.txt
-exports.ansiCompatible = new Map([
+export const ansiCompatible = new Map([
 	['[176A', ['Cursor up Pn lines']],
 	['[176B', ['Cursor down Pn lines']],
 	['[176C', ['Cursor forward Pn characters (right)']],
@@ -78,7 +78,7 @@ exports.ansiCompatible = new Map([
 ]);
 
 // From http://ascii-table.com/ansi-escape-sequences-vt-100.php
-exports.commonCodes = new Map([
+export const commonCodes = new Map([
 	['[176A', ['Move cursor up n lines', 'CUU']],
 	['[176B', ['Move cursor down n lines', 'CUD']],
 	['[176C', ['Move cursor right n lines', 'CUF']],
@@ -183,7 +183,7 @@ exports.commonCodes = new Map([
 ]);
 
 // From http://ascii-table.com/ansi-escape-sequences-vt-100.php
-exports.otherCode = new Map([
+export const otherCode = new Map([
 	['7', ['Save cursor position and attributes', 'DECSC']],
 	['8', ['Restore cursor position and attributes', 'DECSC']],
 
@@ -213,8 +213,8 @@ exports.otherCode = new Map([
 	['6n', ['Get cursor position', 'DSR']]
 ]);
 
-// urxvt escapes
-exports.urxvt = new Map([
+// `urxvt` escapes
+export const urxvt = new Map([
 	['[5~', ['URxvt.keysym.Prior']],
 	['[6~', ['URxvt.keysym.Next']],
 	['[7~', ['URxvt.keysym.Home']],

fixtures/view-codes.js

@@ -1,25 +1,24 @@
-'use strict';
-const ansiRegex = require('..');
-const ansiCodes = require('./ansi-codes');
+import ansiCodes from './ansi-codes.js';
+import ansiRegex from '../index.js';
 
 const allCodes = {};
 const supported = [];
 const unsupported = [];
 
 function addCodesToTest(codes) {
-	for (const code in codes) {
-		allCodes[code] = codes[code];
+	for (const [key, value] of Object.entries(codes)) {
+		allCodes[key] = value;
 	}
 }
 
 function identifySupportedCodes() {
 	let codeSupport = {};
 
-	for (const code in allCodes) {
+	for (const [code, value] of Object.keys(allCodes)) {
 		codeSupport = {
 			code,
 			matches: `\u001B${code}`.match(ansiRegex()),
-			description: allCodes[code][0]
+			description: value[0]
 		};
 
 		if (codeSupport.matches !== null && codeSupport.matches[0] === `\u001B${code}`) {
@@ -34,15 +33,15 @@ function displaySupport() {
 	process.stdout.write('\u001B[32m');
 
 	console.log('SUPPORTED');
-	for (const el of supported) {
-		console.log(el);
+	for (const element of supported) {
+		console.log(element);
 	}
 
 	process.stdout.write('\u001B[31m');
 	console.log('UNSUPPORTED');
 
-	for (const el of unsupported) {
-		console.log(el);
+	for (const element of unsupported) {
+		console.log(element);
 	}
 
 	process.stdout.write('\u001B[0m');

index.d.ts

@@ -0,0 +1,33 @@
+export interface Options {
+	/**
+	Match only the first ANSI escape.
+
+	@default false
+	*/
+	readonly onlyFirst: boolean;
+}
+
+/**
+Regular expression for matching ANSI escape codes.
+
+@example
+```
+import ansiRegex from 'ansi-regex';
+
+ansiRegex().test('\u001B[4mcake\u001B[0m');
+//=> true
+
+ansiRegex().test('cake');
+//=> false
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex());
+//=> ['\u001B[4m', '\u001B[0m']
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
+//=> ['\u001B[4m']
+
+'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
+//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
+```
+*/
+export default function ansiRegex(options?: Options): RegExp;

index.js

@@ -1,10 +1,8 @@
-'use strict';
-
-module.exports = () => {
+export default function ansiRegex({onlyFirst = false} = {}) {
 	const pattern = [
-		'[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\\u0007)',
-		'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))'
+	    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+		'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))'
 	].join('|');
 
-	return new RegExp(pattern, 'g');
-};
+	return new RegExp(pattern, onlyFirst ? undefined : 'g');
+}

index.test-d.ts

@@ -0,0 +1,5 @@
+import {expectType} from 'tsd';
+import ansiRegex from './index.js';
+
+expectType<RegExp>(ansiRegex());
+expectType<RegExp>(ansiRegex({onlyFirst: true}));

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -1,53 +1,58 @@
 {
-  "name": "ansi-regex",
-  "version": "3.0.0",
-  "description": "Regular expression for matching ANSI escape codes",
-  "license": "MIT",
-  "repository": "chalk/ansi-regex",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava",
-    "view-supported": "node fixtures/view-codes.js"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "ansi",
-    "styles",
-    "color",
-    "colour",
-    "colors",
-    "terminal",
-    "console",
-    "cli",
-    "string",
-    "tty",
-    "escape",
-    "formatting",
-    "rgb",
-    "256",
-    "shell",
-    "xterm",
-    "command-line",
-    "text",
-    "regex",
-    "regexp",
-    "re",
-    "match",
-    "test",
-    "find",
-    "pattern"
-  ],
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "ansi-regex",
+	"version": "6.0.1",
+	"description": "Regular expression for matching ANSI escape codes",
+	"license": "MIT",
+	"repository": "chalk/ansi-regex",
+	"funding": "https://github.com/chalk/ansi-regex?sponsor=1",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"engines": {
+		"node": ">=12"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd",
+		"view-supported": "node fixtures/view-codes.js"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"ansi",
+		"styles",
+		"color",
+		"colour",
+		"colors",
+		"terminal",
+		"console",
+		"cli",
+		"string",
+		"tty",
+		"escape",
+		"formatting",
+		"rgb",
+		"256",
+		"shell",
+		"xterm",
+		"command-line",
+		"text",
+		"regex",
+		"regexp",
+		"re",
+		"match",
+		"test",
+		"find",
+		"pattern"
+	],
+	"devDependencies": {
+		"ava": "^3.15.0",
+		"tsd": "^0.14.0",
+		"xo": "^0.38.2"
+	}
 }