Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rferro/interpreting
Require any file extension of interpret dictionary.
https://github.com/rferro/interpreting
babel coffee interpret require
Last synced: 24 days ago
JSON representation
Require any file extension of interpret dictionary.
- Host: GitHub
- URL: https://github.com/rferro/interpreting
- Owner: rferro
- Created: 2017-07-18T03:14:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-26T16:21:50.000Z (over 7 years ago)
- Last Synced: 2024-05-08T21:00:38.304Z (8 months ago)
- Topics: babel, coffee, interpret, require
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/interpreting
- Size: 45.9 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# interpreting
> Require any file extension of interpret dictionary.
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![npmd][npmd]][npmd-url]
[![tests][tests]][tests-url]
[![deps][deps]][deps-url]
[![ddeps][ddeps]][ddeps-url]
[![standard][standard]][standard-url]
Require using the dictionary of file extensions and associated module loaders from [interpret](https://github.com/js-cli/js-interpret) dictionary. Useful, for example, to allow config files in any supported file extension, like requiring webpack config file just doing `interpreting('./webpack.config')`.
Available file extensions and the associated module loader:
- `.js`: *none*
- `.babel.js`: `babel-register`
- `.buble.js`: `buble`
- `.cirru`: `cirru-script`
- `.cjsx`: `node-cjsx`
- `.co`: `coco`
- `.coffee`: `coffee-script`
- `.coffee.md`: `coffee-script`
- `.csv`: `require-csv`
- `.eg`: `earlgrey`
- `.iced`: `iced-coffee-script`
- `.iced.md`: `iced-coffee-script`
- `.ini`: `require-ini`
- `.json`: *none*
- `.json5`: `json5`
- `.jsx`: `babel-register`
- `.litcoffee`: `coffee-script`
- `.liticed`: `iced-coffee-script`
- `.ls`: `livescript`
- `.node`: *none*
- `.toml`: `toml-require`
- `.ts`: `ts-node`
- `.tsx`: `ts-node`
- `.wisp`: `wisp`
- `.xml`: `require-xml`
- `.yaml`: `require-yaml`
- `.yml`: `require-yaml`
## Install
### npm
```sh
npm install --save interpreting
```
### yarn
```sh
yarn add interpreting
```
## Usage
```js
const interpreting = require('interpreting')
// or
import interpreting from 'interpreting'
```
### Examples
```js
// config.babel.js
export const value = 1
```
```js
interpreting('./config')
// { value: 1 }
```
## API
### interpreting(path, [options])
If `path` or `path.*` not exists, returns `null` or throws a error if `options.required` is `true`.
#### path
- Type: `string` `string[]`
File or list of files to require.
#### options
##### required
- Type: `boolean`
- Default: `false`
If true, at least one file must be found.
##### multiple
- Type: `boolean`
- Default: `false`
If `false` returns the first found file. Otherwise, returns an array with all files founded.
##### join
- Type: `boolean`
- Default: `false`
If `true` and `multiple` is true, returns the `Object.assign()` result for all files.
## Resources
- [interpret](https://github.com/js-cli/js-interpret) - A dictionary of file extensions and associated module loaders.
## Authors
- Ricardo Ferro
## License
MIT
[npm]: https://img.shields.io/npm/v/interpreting.svg?style=flat
[npm-url]: https://npmjs.com/package/interpreting
[node]: https://img.shields.io/node/v/interpreting.svg?style=flat
[node-url]: https://nodejs.org
[npmd]: https://img.shields.io/npm/dw/interpreting.svg?style=flat
[npmd-url]: https://www.npmjs.com/package/interpreting
[deps]: https://img.shields.io/david/rferro/interpreting.svg?style=flat
[deps-url]: https://david-dm.org/rferro/interpreting
[ddeps]: https://img.shields.io/david/dev/rferro/interpreting.svg?style=flat
[ddeps-url]: https://david-dm.org/rferro/interpreting?type=dev
[tests]: https://img.shields.io/travis/rferro/interpreting.svg?style=flat
[tests-url]: https://travis-ci.org/rferro/interpreting
[standard]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat
[standard-url]: https://standardjs.com