diff --git a/README.md b/README.md index b82d8e62..fafb5ee2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # @oigroup/lightscript-eslint -> NB: This is a fork of lightscript-eslint which implements language changes that are not necessarily endorsed by upstream. Generally speaking, our intent is to closely follow the upstream language -- however, there may be notable deviations which are documented below. +> `@oigroup/lightscript-eslint` is most frequently tested with `eslint@^4.0.0`. +> It SHOULD be backwards-compatible with `eslint@^3.0.0` as well. `@oigroup/lightscript-eslint` is a fork of `babel-eslint` that parses code with `@oigroup/babylon-lightscript` and `@oigroup/babel-plugin-lightscript`. @@ -12,7 +13,7 @@ all others will be processed exactly as in `babel-eslint`. To use, just `npm install --save-dev @oigroup/lightscript-eslint` and add `parser: "@oigroup/lightscript-eslint"` to your `.eslintrc`. -Testing so far has been limited; this is very much alpha software and it may not work well. So far, it is has seen limited use with the following configuration: +Example configuration (with React): ```json { @@ -28,10 +29,10 @@ Testing so far has been limited; this is very much alpha software and it may not "browser": true, "node": true, "es6": true - }, - "rules": { - "semi": ["error", "never"], - "react/require-render-return": 0 } } ``` + +### Contributing + +Issues: https://github.com/wcjohnson/lightscript/issues diff --git a/package.json b/package.json index c8c6b649..1217c389 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ ], "repository": { "type": "git", - "url": "https://github.com/lightscript/lightscript-eslint.git" + "url": "https://github.com/wcjohnson/lightscript-eslint.git" }, "dependencies": { "@oigroup/babel-plugin-lightscript": "3.0.0-beta.1", @@ -29,13 +29,13 @@ "preversion": "npm test", "changelog": "git log `git describe --tags --abbrev=0`..HEAD --pretty=format:' * %s (%an)' | grep -v 'Merge pull request'" }, - "homepage": "http://lightscript.org", + "homepage": "http://wcjohnson.github.io/lightscript", "license": "MIT", "engines": { "node": ">=4" }, "bugs": { - "url": "https://github.com/lightscript/lightscript-eslint/issues" + "url": "https://github.com/wcjohnson/lightscript/issues" }, "devDependencies": { "babel-eslint": "^7.2.1",