This commit is contained in:
Tutur33
2023-11-24 23:58:26 +01:00
parent 25395c0ee1
commit 938ad9d309
4191 changed files with 41 additions and 518781 deletions
-14
View File
@@ -1,14 +0,0 @@
## 0.15.3
- Move @types dependencies to dev dependencies.
- Upgrade dependencies.
## 0.15.2
- Fix publish.
## 0.15.1
- Update dependencies.
## 0.15.0
- Convert source code into TypeScript. Generated type definitions are now provided.
- Remove dependency on Bluebird.
- **Breaking**: Node v4 no longer supported.
-19
View File
@@ -1,19 +0,0 @@
Copyright © 2012 EditorConfig Team
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.
-206
View File
@@ -1,206 +0,0 @@
# EditorConfig JavaScript Core
[![Build Status](https://travis-ci.org/editorconfig/editorconfig-core-js.svg?branch=master)](https://travis-ci.org/editorconfig/editorconfig-core-js)
[![dependencies Status](https://david-dm.org/editorconfig/editorconfig-core-js/status.svg)](https://david-dm.org/editorconfig/editorconfig-core-js)
The EditorConfig JavaScript core will provide the same functionality as the
[EditorConfig C Core][] and [EditorConfig Python Core][].
## Installation
You need [node][] to use this package.
To install the package locally:
```bash
$ npm install editorconfig
```
To install the package system-wide:
```bash
$ npm install -g editorconfig
```
## Usage
### in Node.js:
#### parse(filePath[, options])
options is an object with the following defaults:
```js
{
config: '.editorconfig',
version: pkg.version,
root: '/'
};
```
Search for `.editorconfig` starting from the current directory to the root directory.
Example:
```js
var editorconfig = require('editorconfig');
var path = require('path');
var filePath = path.join(__dirname, '/sample.js');
var promise = editorconfig.parse(filePath);
promise.then(function onFulfilled(result) {
console.log(result);
});
/*
{
indent_style: 'space',
indent_size: 2,
end_of_line: 'lf',
charset: 'utf-8',
trim_trailing_whitespace: true,
insert_final_newline: true,
tab_width: 2
};
*/
```
#### parseSync(filePath[, options])
Synchronous version of `editorconfig.parse()`.
#### parseString(fileContent)
The `parse()` function above uses `parseString()` under the hood. If you have your file contents
just pass it to `parseString()` and it'll return the same results as `parse()`.
#### parseFromFiles(filePath, configs[, options])
options is an object with the following defaults:
```js
{
config: '.editorconfig',
version: pkg.version,
root: '/'
};
```
Specify the `.editorconfig`.
Example:
```js
var editorconfig = require('editorconfig');
var fs = require('fs');
var path = require('path');
var configPath = path.join(__dirname, '/.editorconfig');
var configs = [
{
name: configPath,
contents: fs.readFileSync(configPath, 'utf8')
}
];
var filePath = path.join(__dirname, '/sample.js');
var promise = editorconfig.parseFromFiles(filePath, configs);
promise.then(function onFulfilled(result) {
console.log(result)
});
/*
{
indent_style: 'space',
indent_size: 2,
end_of_line: 'lf',
charset: 'utf-8',
trim_trailing_whitespace: true,
insert_final_newline: true,
tab_width: 2
};
*/
```
#### parseFromFilesSync(filePath, configs[, options])
Synchronous version of `editorconfig.parseFromFiles()`.
### in Command Line
```bash
$ ./bin/editorconfig
Usage: editorconfig [OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]
EditorConfig Node.js Core Version 0.11.4-development
FILEPATH can be a hyphen (-) if you want path(s) to be read from stdin.
Options:
-h, --help output usage information
-V, --version output the version number
-f <path> Specify conf filename other than ".editorconfig"
-b <version> Specify version (used by devs to test compatibility)
```
Example:
```bash
$ ./bin/editorconfig /home/zoidberg/humans/anatomy.md
charset=utf-8
insert_final_newline=true
end_of_line=lf
tab_width=8
trim_trailing_whitespace=sometimes
```
## Development
To install dependencies for this package run this in the package directory:
```bash
$ npm install
```
Next, run the following commands:
```bash
$ npm run build
$ npm run copy
$ npm link ./dist
```
The global editorconfig will now point to the files in your development
repository instead of a globally-installed version from npm. You can now use
editorconfig directly to test your changes.
If you ever update from the central repository and there are errors, it might
be because you are missing some dependencies. If that happens, just run npm
link again to get the latest dependencies.
To test the command line interface:
```bash
$ editorconfig <filepath>
```
# Testing
[CMake][] must be installed to run the tests.
To run the tests:
```bash
$ npm test
```
To run the tests with increased verbosity (for debugging test failures):
```bash
$ npm run-script test-verbose
```
[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core
[EditorConfig Python Core]: https://github.com/editorconfig/editorconfig-core-py
[node]: http://nodejs.org/
[cmake]: http://www.cmake.org
-59
View File
@@ -1,59 +0,0 @@
{
"name": "editorconfig",
"version": "0.15.3",
"description": "EditorConfig File Locator and Interpreter for Node.js",
"keywords": [
"editorconfig",
"core"
],
"main": "src/index.js",
"contributors": [
"Hong Xu (topbug.net)",
"Jed Mao (https://github.com/jedmao/)",
"Trey Hunner (http://treyhunner.com)"
],
"directories": {
"bin": "./bin",
"lib": "./lib"
},
"scripts": {
"clean": "rimraf dist",
"prebuild": "npm run clean",
"build": "tsc",
"pretest": "npm run lint && npm run build && npm run copy && cmake .",
"test": "ctest .",
"pretest:ci": "npm run pretest",
"test:ci": "ctest -VV --output-on-failure .",
"lint": "npm run eclint && npm run tslint",
"eclint": "eclint check --indent_size ignore \"src/**\"",
"tslint": "tslint --project tsconfig.json --exclude package.json",
"copy": "cpy .npmignore LICENSE README.md CHANGELOG.md dist && cpy bin/* dist/bin && cpy src/lib/fnmatch*.* dist/src/lib",
"prepub": "npm run lint && npm run build && npm run copy",
"pub": "npm publish ./dist"
},
"repository": {
"type": "git",
"url": "git://github.com/editorconfig/editorconfig-core-js.git"
},
"bugs": "https://github.com/editorconfig/editorconfig-core-js/issues",
"author": "EditorConfig Team",
"license": "MIT",
"dependencies": {
"commander": "^2.19.0",
"lru-cache": "^4.1.5",
"semver": "^5.6.0",
"sigmund": "^1.0.1"
},
"devDependencies": {
"@types/mocha": "^5.2.6",
"@types/node": "^10.12.29",
"@types/semver": "^5.5.0",
"cpy-cli": "^2.0.0",
"eclint": "^2.8.1",
"mocha": "^5.2.0",
"rimraf": "^2.6.3",
"should": "^13.2.3",
"tslint": "^5.13.1",
"typescript": "^3.3.3333"
}
}