{"_id":"@armano/typescript-eslint-parser","_rev":"2-20e78985fb682dbdb41340e16a2eb078","name":"@armano/typescript-eslint-parser","dist-tags":{"latest":"21.0.3"},"versions":{"21.0.1":{"name":"@armano/typescript-eslint-parser","description":"An ESLint custom parser which leverages TypeScript ESTree","author":{"name":"Nicholas C. Zakas","email":"nicholas+npm@nczconsulting.com"},"homepage":"https://github.com/eslint/typescript-eslint-parser","main":"parser.js","version":"21.0.1","engines":{"node":">=6.14.0"},"repository":{"type":"git","url":"git+https://github.com/eslint/typescript-eslint-parser.git"},"bugs":{"url":"https://github.com/eslint/typescript-eslint-parser/issues"},"license":"BSD-2-Clause","keywords":["ast","ecmascript","javascript","typescript","parser","syntax","eslint"],"scripts":{"test":"node Makefile.js test","jest":"jest","integration-tests":"docker-compose -f tests/integration/docker-compose.yml up","kill-integration-test-containers":"docker-compose -f tests/integration/docker-compose.yml down -v --rmi local","lint":"node Makefile.js lint","generate-release":"eslint-generate-release","generate-alpharelease":"eslint-generate-prerelease alpha","generate-betarelease":"eslint-generate-prerelease beta","generate-rcrelease":"eslint-generate-prerelease rc","publish-release":"eslint-publish-release"},"peerDependencies":{"eslint":">=4.19.1","typescript":"*"},"dependencies":{"eslint-scope":"^4.0.0","eslint-visitor-keys":"^1.0.0","lodash":"^4.17.11","typescript-estree":"5.0.0"},"devDependencies":{"eslint":"^4.19.1","eslint-config-eslint":"4.0.0","eslint-plugin-node":"6.0.1","eslint-release":"1.2.0","jest":"23.1.0","npm-license":"0.3.3","shelljs":"0.8.2","shelljs-nodecli":"0.1.1","typescript":"~3.1.1"},"jest":{"testEnvironment":"node","testRegex":"tests/lib/.+\\.js$","testPathIgnorePatterns":[],"collectCoverage":true,"coverageReporters":["text-summary"]},"gitHead":"1e2ce62bd78760295e128364cc0fcce81d2e71bc","_id":"@armano/typescript-eslint-parser@21.0.1","_npmVersion":"6.4.1","_nodeVersion":"10.11.0","_npmUser":{"name":"armano","email":"pwszewczyk9@gmail.com"},"dist":{"integrity":"sha512-FzSuJIclt2nXJBLTKxXjVA5wAOYk7ZiVlHqBYvBC1E7/6yOAlY4HDbheDbxElNFyZTB0KOyfWMlnZqoKdu3a6g==","shasum":"082b5d7ec2a98ef54cea1259545719f4d8723207","tarball":"https://registry.npmjs.org/@armano/typescript-eslint-parser/-/typescript-eslint-parser-21.0.1.tgz","fileCount":7,"unpackedSize":56825,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb9x6yCRA9TVsSAnZWagAAsfsP/j5l+6WtCOEO4hzjikmi\nJuN5hdWMcTUnil0xlKxmjKs3GRo8xYD2gt4mVdL/09JMjE5QJlulUS2eXGoS\nwalddnNQLXmyj8XmYlUkLY+YpNuVmhv9pyhr3D/CW5f50o+1DWSHo+oLOqgV\ncwqaidIcxuvSXsi34rOcCtjuNMjkdIdod+Q/4db9ZiL5H08aY6yH2mGqbkAO\nHIHdWoepIgdtwkWr5RIOB1YIc4jXpMFBYlsDlrB4hzubRP+c/KQDvvjWioV0\nugz+ZJ0gJoTZyLfDDJW69YqTH1/PdJZRSR3ZesctLLPJcTlcxVtCnyNlBXdU\nCDRpUUtzSZFXy8MDVsxIpu2fNSDK6PLQ8R46Te58UVxp7Nw1YRbi5NbMLT74\n6VJKPiv4B95reJe6hd+HON/FDKwBX1zPk6j3vO1XttC1fz+k7+HQdwqXt843\nomc8uARxham7Fj+PWQgh2PYj2ExrUGrYBbTgPrLfLVYKKuNpKN+M2EpDBATS\nUP5Le+5aFMHJ4bltYx1SzupI0+E8rlA3NNKP7j6Vdxpn36f99uvwGG5AeELW\npClHKEyEKvZRQDS6pVBOI+ScXW7KAgqEndpTw1n0RNbnTreMLwrVo3XleVCQ\nXuolBijJu8XxDLhP0OA1x1x5iNyni29Bpqvd1qCUgprr6s2hu33JmPFRNZoT\n24VS\r\n=ku3v\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEbeA1b0TK2H+ChWg8jw0+e1l3s8Xp6Xq/d32hnMbfidAiEAtOpg4j4GwG2DBpMrQDg9ODyZ0LTjo80ZiMIxC6+n9zg="}]},"maintainers":[{"name":"armano","email":"pwszewczyk9@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typescript-eslint-parser_21.0.1_1542921905612_0.8070530381709065"},"_hasShrinkwrap":false},"21.0.3":{"name":"@armano/typescript-eslint-parser","description":"An ESLint custom parser which leverages TypeScript ESTree","author":{"name":"Nicholas C. Zakas","email":"nicholas+npm@nczconsulting.com"},"homepage":"https://github.com/eslint/typescript-eslint-parser","main":"parser.js","version":"21.0.3","engines":{"node":">=6.14.0"},"repository":{"type":"git","url":"git+https://github.com/eslint/typescript-eslint-parser.git"},"bugs":{"url":"https://github.com/eslint/typescript-eslint-parser/issues"},"license":"BSD-2-Clause","keywords":["ast","ecmascript","javascript","typescript","parser","syntax","eslint"],"scripts":{"test":"node Makefile.js test","jest":"jest","integration-tests":"docker-compose -f tests/integration/docker-compose.yml up","kill-integration-test-containers":"docker-compose -f tests/integration/docker-compose.yml down -v --rmi local","lint":"node Makefile.js lint","generate-release":"eslint-generate-release","generate-alpharelease":"eslint-generate-prerelease alpha","generate-betarelease":"eslint-generate-prerelease beta","generate-rcrelease":"eslint-generate-prerelease rc","publish-release":"eslint-publish-release"},"peerDependencies":{"eslint":">=4.19.1","typescript":"*"},"dependencies":{"eslint-scope":"^4.0.0","eslint-visitor-keys":"^1.0.0","typescript-estree":"5.3.0"},"devDependencies":{"eslint":"^4.19.1","eslint-config-eslint":"4.0.0","eslint-plugin-node":"6.0.1","eslint-release":"1.2.0","jest":"23.1.0","npm-license":"0.3.3","shelljs":"0.8.2","shelljs-nodecli":"0.1.1","typescript":"~3.1.1"},"jest":{"testEnvironment":"node","testRegex":"tests/lib/.+\\.js$","testPathIgnorePatterns":[],"collectCoverage":true,"coverageReporters":["text-summary"]},"gitHead":"b4708dfe743e18110531a56aab32c90f384e6fce","_id":"@armano/typescript-eslint-parser@21.0.3","_npmVersion":"6.4.1","_nodeVersion":"11.4.0","_npmUser":{"name":"armano","email":"pwszewczyk9@gmail.com"},"dist":{"integrity":"sha512-A2v5dSAtdEe9Y2tFcaZ+PLzVcaqmjnzSdNWfLtZrzrwR9mXwRLqZChabqs/4du5HnT1GTzMnhyPqv32trj13Fg==","shasum":"d7674ee6734064712b75da5ebe7f01eaae799a9a","tarball":"https://registry.npmjs.org/@armano/typescript-eslint-parser/-/typescript-eslint-parser-21.0.3.tgz","fileCount":7,"unpackedSize":57591,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcGUZnCRA9TVsSAnZWagAAvywP/2qIS32UxqW60ZV/PSXx\n+8ZAs/q1B/gIoqV01sZbxswoQQc7RxPVrid7bC2SgPkT6KFMMV/uqzgrIy/F\ndoIQRoKG90gSODF1YCr+gkdexPxX9efzeaGdIArJlCK+s3CuP9yY0VF123mX\nXiv5CD32fOfEru6vOMLcD9wY38S0FOghhquAijTkbSjvxP0dKeN41a9r1mLR\nD1RSLHN9AU6uEFkVI0+EeuK448Q64M0gEV/3NQME4vw12q8nOnjvhPRuB/Yt\nySCloDs5UjiqEk0QJ3jMN3UcaYA7p2txnOEb4Sr8G0iEKny78pUqU83DgGUn\nZOOB1CDe8o40qp4xIE9POlHch32U2RVq6bVAn6WMd5OPquy3Sznqe5ff9ysB\nTqIhj2MHLnghaw0Uh0yxMCCi97z0NUAfKlJfFmMycu5viNRBXF8zAjJcGBJC\nSxZPDv4HD71lXNaiS329DkgUv6vlBJBGBxI7I7P0BftNfCLFqsQlggFndQjw\nNvbUL0LuT8CSusk0SyWSgiVqg3el9G8oxHu8aouMljpeR5joXjiLZIf9M5xi\nIwjBKsC4tsF67NGgjrabU963ld1/hNxtPwjGLZXsQEsDKN+/1aGaKIf0uI5M\n0O/WZslWl64ZvfGM4Q1E/MuquyLBPgxXS8Nh736L4o9sAdSqfaKg3I5TXMbO\n8pD2\r\n=nm+N\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDjf6AWizm4/9TQj5KDIrpRm2uqcAy9kS4FMzYC1eQSewIhAPOc07lfANyFLNyDliTrOoRhMsXP5utGJmlcFHxCx8Hy"}]},"maintainers":[{"name":"armano","email":"pwszewczyk9@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typescript-eslint-parser_21.0.3_1545160295087_0.7940467907082949"},"_hasShrinkwrap":false}},"time":{"created":"2018-11-22T21:25:05.443Z","21.0.1":"2018-11-22T21:25:05.758Z","modified":"2022-04-04T15:32:57.719Z","21.0.3":"2018-12-18T19:11:35.181Z"},"maintainers":[{"name":"armano","email":"pwszewczyk9@gmail.com"}],"description":"An ESLint custom parser which leverages TypeScript ESTree","homepage":"https://github.com/eslint/typescript-eslint-parser","keywords":["ast","ecmascript","javascript","typescript","parser","syntax","eslint"],"repository":{"type":"git","url":"git+https://github.com/eslint/typescript-eslint-parser.git"},"author":{"name":"Nicholas C. Zakas","email":"nicholas+npm@nczconsulting.com"},"bugs":{"url":"https://github.com/eslint/typescript-eslint-parser/issues"},"license":"BSD-2-Clause","readme":"> <h1>Help Wanted!</h1>\n> If you're familiar with TypeScript and ESLint, and you'd like to see this project progress, please consider contributing. We need people with a good knowledge of TypeScript to ensure that the integration with the ESLint ecosystem is useful.\n\n# TypeScript ESLint Parser\n\nAn ESLint custom parser which leverages [TypeScript ESTree](https://github.com/JamesHenry/typescript-estree) to allow for ESLint to lint TypeScript source code.\n\n\n## Installation:\n\n```sh\nnpm install --save-dev typescript-eslint-parser\n```\n\n## Usage\n\nIn your ESLint configuration file, set the `parser` property:\n\n```json\n{\n    \"parser\": \"typescript-eslint-parser\"\n}\n```\n\nThere is sometimes an incorrect assumption that the parser itself is what does everything necessary to facilitate the use of ESLint with TypeScript. In actuality, it is the combination of the parser _and_ one or more plugins which allow you to maximize your usage of ESLint with TypeScript.\n\nFor example, once this parser successfully produces an AST for the TypeScript source code, it might well contain some information which simply does not exist in a standard JavaScript context, such as the data for a TypeScript-specific construct, like an `interface`.\n\nThe core rules built into ESLint, such as `indent` have no knowledge of such constructs, so it is impossible to expect them to work out of the box with them.\n\nInstead, you also need to make use of one more plugins which will add or extend rules with TypeScript-specific features.\n\nBy far the most common case will be installing the [eslint-plugin-typescript](https://github.com/nzakas/eslint-plugin-typescript) plugin, but there are also other relevant options available such a [eslint-plugin-tslint](https://github.com/JamesHenry/eslint-plugin-tslint).\n\n## Configuration\n\nThe following additional configuration options are available by specifying them in [`parserOptions`](https://eslint.org/docs/user-guide/configuring#specifying-parser-options) in your ESLint configuration file.\n\n- **`jsx`** - default `false`. Enable parsing JSX when `true`. More details can be found [here](https://www.typescriptlang.org/docs/handbook/jsx.html).\n    - It's `false` on `*.ts` files regardless of this option.\n    - It's `true` on `*.tsx` files regardless of this option.\n    - Otherwise, it respects this option.\n\n- **`useJSXTextNode`** - default `true`. Please set `false` if you use this parser on ESLint v4. If this is `false`, the parser creates the AST of JSX texts as the legacy style.\n\n### .eslintrc.json\n\n```json\n{\n    \"parser\": \"typescript-eslint-parser\",\n    \"parserOptions\": {\n        \"jsx\": true,\n        \"useJSXTextNode\": true\n    }\n}\n```\n\n## Supported TypeScript Version\n\nWe will always endeavor to support the latest stable version of TypeScript.\n\nThe version of TypeScript currently supported by this parser is `~3.1.1`. This is reflected in the `devDependency` requirement within the package.json file, and it is what the tests will be run against. We have an open `peerDependency` requirement in order to allow for experimentation on newer/beta versions of TypeScript.\n\nIf you use a non-supported version of TypeScript, the parser will log a warning to the console.\n\n**Please ensure that you are using a supported version before submitting any issues/bug reports.**\n\n## Reporting Issues\n\nPlease **do not report parsing/AST issues in this repo**, report them directly to [TypeScript ESTree](https://github.com/JamesHenry/typescript-estree).\n\nPlease check the current list of open and known issues and ensure the issue has not been reported before. When creating a new issue provide as much information about your environment as possible. This includes:\n\n- ESLint Version\n- TypeScript version\n- The `typescript-eslint-parser` version\n- ESLint config or rules and plugins currently enabled\n\n## Integration Tests\n\nWe have a very flexible way of running integration tests which connects all of the moving parts of the usage of this parser in the ESLint ecosystem.\n\nWe run each test within its own docker container, and so each one has complete autonomy over what dependencies/plugins are installed and what versions are used. This also has the benefit of not bloating the `package.json` and `node_modules` of the parser project itself.\n\n> If you are going to submit an issue related to the usage of this parser with ESLint, please consider creating a failing integration test which clearly demonstrates the behavior. It's honestly super quick!\n\nYou just need to duplicate one of the existing test sub-directories found in `tests/integration/`, tweak the dependencies and ESLint config to match what you need, and add a new entry to the docker-compose.yml file which matches the format of the existing ones.\n\nThen run:\n\n```sh\nnpm run integration-tests\n```\n\nIf you ever need to change what gets installed when the docker images are built by docker-compose, you will first need to kill the existing containers by running:\n\n```sh\nnpm run kill-integration-test-containers\n```\n\n## Contributing\n\nIssues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/typescript-eslint-parser/issues).\n\n## Build Commands\n\n- `npm test` - run all linting and tests\n- `npm run lint` - run all linting\n- `npm run integration-tests` - run only integration tests\n\n## License\n\nTypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.\n","readmeFilename":"README.md"}