mirror of
https://github.com/arthur-pbty/portfolio2023.git
synced 2026-06-12 08:14:39 +02:00
modified
This commit is contained in:
Tutur33
-21
@@ -1,21 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) egoist <0x142857@gmail.com> (https://github.com/egoist)
|
||||
|
||||
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:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
-133
@@ -1,133 +0,0 @@
|
||||
|
||||
# joycon
|
||||
|
||||
[](https://npmjs.com/package/joycon) [](https://npmjs.com/package/joycon) [](https://packagephobia.now.sh/result?p=joycon@2.0.0) [](https://circleci.com/gh/egoist/joycon/tree/master) [](https://github.com/egoist/donate) [](https://chat.egoist.moe)
|
||||
|
||||
## Differences with [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)?
|
||||
|
||||
JoyCon is zero-dependency but feature-complete.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
yarn add joycon
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const JoyCon = require('joycon')
|
||||
|
||||
const joycon = new JoyCon()
|
||||
|
||||
joycon.load(['package-lock.json', 'yarn.lock'])
|
||||
.then(result => {
|
||||
// result is {} when files do not exist
|
||||
// otherwise { path, data }
|
||||
})
|
||||
```
|
||||
|
||||
By default non-js files are parsed as JSON, if you want something different you can add a loader:
|
||||
|
||||
```js
|
||||
const joycon = new JoyCon()
|
||||
|
||||
joycon.addLoader({
|
||||
test: /\.toml$/,
|
||||
load(filepath) {
|
||||
return require('toml').parse(filepath)
|
||||
}
|
||||
})
|
||||
|
||||
joycon.load(['cargo.toml'])
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### constructor([options])
|
||||
|
||||
#### options
|
||||
|
||||
##### files
|
||||
|
||||
- Type: `string[]`
|
||||
|
||||
The files to search.
|
||||
|
||||
##### cwd
|
||||
|
||||
The directory to search files.
|
||||
|
||||
##### stopDir
|
||||
|
||||
The directory to stop searching.
|
||||
|
||||
##### packageKey
|
||||
|
||||
You can load config from certain property in a `package.json` file. For example, when you set `packageKey: 'babel'`, it will load the `babel` property in `package.json` instead of the entire data.
|
||||
|
||||
##### parseJSON
|
||||
|
||||
- Type: `(str: string) => any`
|
||||
- Default: `JSON.parse`
|
||||
|
||||
The function used to parse JSON string.
|
||||
|
||||
### resolve([files], [cwd], [stopDir])
|
||||
### resolve([options])
|
||||
|
||||
`files` defaults to `options.files`.
|
||||
|
||||
`cwd` defaults to `options.cwd`.
|
||||
|
||||
`stopDir` defaults to `options.stopDir` then `path.parse(cwd).root`.
|
||||
|
||||
If using a single object `options`, it will be the same as constructor options.
|
||||
|
||||
Search files and resolve the path of the file we found.
|
||||
|
||||
There's also `.resolveSync` method.
|
||||
|
||||
### load(...args)
|
||||
|
||||
The signature is the same as [resolve](#resolvefiles-cwd-stopdir).
|
||||
|
||||
Search files and resolve `{ path, data }` of the file we found.
|
||||
|
||||
There's also `.loadSync` method.
|
||||
|
||||
### addLoader(Loader)
|
||||
|
||||
```typescript
|
||||
interface Loader {
|
||||
name?: string
|
||||
test: RegExp
|
||||
load(filepath: string)?: Promise<any>
|
||||
loadSync(filepath: string)?: any
|
||||
}
|
||||
```
|
||||
|
||||
At least one of `load` and `loadSync` is required, depending on whether you're calling the synchonous methods or not.
|
||||
|
||||
### removeLoader(name)
|
||||
|
||||
Remove loaders by loader name.
|
||||
|
||||
### clearCache()
|
||||
|
||||
Each JoyCon instance uses its own cache.
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork it!
|
||||
2. Create your feature branch: `git checkout -b my-new-feature`
|
||||
3. Commit your changes: `git commit -am 'Add some feature'`
|
||||
4. Push to the branch: `git push origin my-new-feature`
|
||||
5. Submit a pull request :D
|
||||
|
||||
## Author
|
||||
|
||||
**joycon** © [egoist](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br>
|
||||
Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/joycon/contributors)).
|
||||
|
||||
> [github.com/egoist](https://github.com/egoist) · GitHub [@egoist](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)
|
||||
-39
@@ -1,39 +0,0 @@
|
||||
{
|
||||
"name": "joycon",
|
||||
"version": "3.1.1",
|
||||
"description": "Load config with ease.",
|
||||
"repository": {
|
||||
"url": "egoist/joycon",
|
||||
"type": "git"
|
||||
},
|
||||
"main": "lib/index.js",
|
||||
"types": "types/index.d.ts",
|
||||
"files": [
|
||||
"lib",
|
||||
"types/index.d.ts"
|
||||
],
|
||||
"scripts": {
|
||||
"test": "jest --testPathPattern tests",
|
||||
"build": "babel src -d lib --no-comments",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"author": "egoist <0x142857@gmail.com>",
|
||||
"license": "MIT",
|
||||
"jest": {
|
||||
"testEnvironment": "node"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/cli": "^7.13.10",
|
||||
"@babel/core": "^7.13.10",
|
||||
"@babel/preset-env": "^7.13.10",
|
||||
"@egoist/prettier-config": "^0.1.0",
|
||||
"@types/node": "^14.14.33",
|
||||
"babel-jest": "^26.6.3",
|
||||
"babel-plugin-sync": "^0.1.0",
|
||||
"jest-cli": "^26.6.3",
|
||||
"prettier": "^2.2.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user