Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flex-development/ext-regex
File extension regex
https://github.com/flex-development/ext-regex
ext extname file-extension file-extensions regex typescript
Last synced: about 2 months ago
JSON representation
File extension regex
- Host: GitHub
- URL: https://github.com/flex-development/ext-regex
- Owner: flex-development
- License: bsd-3-clause
- Created: 2023-02-14T19:53:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T21:53:59.000Z (9 months ago)
- Last Synced: 2024-05-01T09:40:36.690Z (8 months ago)
- Topics: ext, extname, file-extension, file-extensions, regex, typescript
- Language: JavaScript
- Homepage: https://github.com/flex-development/ext-regex
- Size: 1.49 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ext-regex
[](https://github.com/flex-development/ext-regex/releases/latest)
[](https://npmjs.com/package/@flex-development/ext-regex)
[](https://codecov.io/gh/flex-development/ext-regex)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://conventionalcommits.org/)
[](https://typescriptlang.org/)
[](https://vitest.dev/)
[](https://yarnpkg.com/)
File extension regex
## Contents
- [What is this?](#what-is-this)
- [When should I use this?](#when-should-i-use-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [`EXT_DTS_REGEX`](#ext_dts_regex)
- [`EXT_JS_REGEX`](#ext_js_regex)
- [`EXT_JSON_REGEX`](#ext_json_regex)
- [`EXT_TS_REGEX`](#ext_ts_regex)
- [`extRegex(ext[, options])`](#extregexext-options)
- [Types](#types)
- [Interfaces](#interfaces)
- [Related](#related)
- [Contribute](#contribute)
## What is this?
This package exports regular expressions suitable for matching file extensions. It also provides a regular expression
factory function to create file extension expressions.
## When should I use this?
Regular expressions exported from this package can be used to test both file extensions and names. A factory function is
also exported that can be used to create a regular expression for any given file extension.
**Note**:
- Expressions are ECMAScript-compatible. They have not been tested with other flavors (PCRE, PCRE2, etc)
## Install
This package is [ESM only][1].
```sh
yarn add @flex-development/ext-regex
```
From Git:
```sh
yarn add @flex-development/ext-regex@flex-development/ext-regex
```
See Git - Protocols | Yarn
for details on requesting a specific branch, commit, or tag.
## Use
```typescript
import { DECORATOR_REGEX } from '@flex-development/ext-regex'
import { EXT_DTS_REGEX, EXT_TS_REGEX } from '@flex-development/ext-regex'
import * as mlly from '@flex-development/mlly'
import pathe from '@flex-development/pathe'
import * as tscu from '@flex-development/tsconfig-utils'
import type { Nullable } from '@flex-development/tutils'
import type {
OnLoadArgs,
OnLoadOptions,
OnLoadResult,
Plugin,
PluginBuild
} from 'esbuild'
import type { URL } from 'node:url'
/**
* Returns a plugin that allows esbuild to handle [`emitDecoratorMetadata`][1].
*
* [1]: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata
*
* @param {tscu.LoadTsconfigOptions?} [options] - Plugin options
* @return {Plugin} Decorator metadata plugin
*/
const plugin = (options?: tscu.LoadTsconfigOptions): Plugin => ({
name: 'decorators',
setup: async ({ initialOptions, onLoad }: PluginBuild): Promise => {
const { absWorkingDir = '.', tsconfig = 'tsconfig.json' } = initialOptions
/**
* User compiler options.
*
* @const {tscu.CompilerOptions} compilerOptions
*/
const compilerOptions: tscu.CompilerOptions = tscu.loadCompilerOptions(
pathe.resolve(absWorkingDir, tsconfig),
options
)
// exit early if decorator metadata should not be emitted
if (!compilerOptions.emitDecoratorMetadata) return void 0
/**
* TypeScript module.
*
* @const {typeof import('typescript')} ts
*/
const ts: typeof import('typescript') = (await import('typescript')).default
/**
* {@linkcode onLoad} callback options.
*
* @const {OnLoadOptions}
*/
const opts: OnLoadOptions = { filter: /.*/ }
// transpile typescript modules containing decorators
onLoad(opts, async (args: OnLoadArgs): Promise> => {
/**
* Callback result.
*
* @var {Nullable} result
*/
let result: Nullable = null
// transpile typescript modules, but skip typescript declaration modules
if (EXT_TS_REGEX.test(args.path) && !EXT_DTS_REGEX.test(args.path)) {
/**
* URL of module to load.
*
* @const {URL} url
*/
const url: URL = mlly.toURL(args.path)
/**
* File content at {@linkcode args.path}.
*
* @const {string} source
*/
const source: string = (await mlly.getSource(url)) as string
// do nothing if module does not use decorators
if (!DECORATOR_REGEX.test(source)) return null
// transpile module to emit decorator metadata
const { outputText: contents } = ts.transpileModule(source, {
compilerOptions: tscu.normalizeCompilerOptions(compilerOptions)
})
result = { contents }
}
return result
})
return void 0
}
})
export default plugin
```
Looking for a plugin like this? Check out
mkbuild 😉
## API
This package exports the following identifiers:
- [`EXT_DTS_REGEX`](#ext_dts_regex)
- [`EXT_JS_REGEX`](#ext_js_regex)
- [`EXT_JSON_REGEX`](#ext_json_regex)
- [`EXT_TS_REGEX`](#ext_ts_regex)
- [`extRegex`](#extregexext-options)
There is no default export.
### `EXT_DTS_REGEX`
TypeScript declaration file extension regex.
Supported extensions:
- `.d.cts`
- `.d.mts`
- `.d.ts`
Named capturing groups:
- `type`: Letter between `'.'` and `'ts'` in file extension
#### Source
> [`src/regex/dts.ts`](src/regex/dts.ts)
### `EXT_JS_REGEX`
JavaScript file extension regex.
Supported extensions:
- `.cjs`
- `.js`
- `.jsx`
- `.mjs`
Named capturing groups:
- `type`: Letter between `'.'` and `'js'` in file extension
#### Source
> [`src/regex/js.ts`](src/regex/js.ts)
### `EXT_JSON_REGEX`
JSON file extension regex.
Supported extensions:
- `.json`
- `.json5`
- `.jsonc`
Named capturing groups:
- `type`: Character after `'json'` in file extension
#### Source
> [`src/regex/json.ts`](src/regex/json.ts)
### `EXT_TS_REGEX`
TypeScript file extension regex.
Supported extensions:
- `.cts`
- `.d.cts`
- `.d.mts`
- `.d.ts`
- `.mts`
- `.ts`
- `.tsx`
Named capturing groups:
- `dts`: Letter `'d'` if extension is [declaration file extension](#ext_dts_regex)
- `type`: Letter between `'.'` and `'ts'` in file extension
#### Source
> [`src/regex/ts.ts`](src/regex/ts.ts)
### `extRegex(ext[, options])`
Creates a regular expression matching the given file extension, `ext`.
The file extension does not need to begin with a dot character (`'.'`). If it doesn't, however, it will be formatted
before being converted into a regular expression pattern. The returned regular expression will match the formatted file
extension instead.
#### Parameters
- `{string}` **`ext`** — File extension to evaluate
- `{Options?}` **`[options]`** — Regular expression options
#### Returns
`{RegExp}` Regular expression matching `ext`.
#### Throws
`{errnode.NodeError}` If `ext` is not a string.
#### Source
> [`src/utils/ext-regex.ts`](src/utils/ext-regex.ts)
## Types
This package is fully typed with [TypeScript][2].
### Interfaces
- [`Options`](src/interfaces/options.ts)
## Related
- [`ext-regex`][3] — [Decorator][4] regex
- [`export-regex`][5] — `export` statement regex
- [`import-regex`][6] — `import` statement regex
## Contribute
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
[1]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[2]: https://www.typescriptlang.org
[3]: https://github.com/flex-development/ext-regex
[4]: https://github.com/tc39/proposal-decorators
[5]: https://github.com/flex-development/export-regex
[6]: https://github.com/flex-development/import-regex