├── .eslintrc.json ├── .gitignore ├── .npmignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── NOTICE ├── README.md ├── package.json ├── src ├── index.ts └── rules │ └── no-date-parsing.ts ├── tests ├── .eslintrc.json ├── tests.ts └── tsconfig.json ├── tsconfig-dist.json └── tsconfig.json /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "parser": "@typescript-eslint/parser", 3 | "parserOptions": { 4 | "ecmaVersion": 2019, 5 | "project": "tsconfig.json", 6 | "sourceType": "module" 7 | }, 8 | "root": true 9 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | /dist 3 | /node_modules 4 | /temp 5 | package-lock.json -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | src/ 2 | tests/ 3 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | ## Code of Conduct 2 | This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 3 | For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 4 | opensource-codeofconduct@amazon.com with any additional questions or comments. 5 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing Guidelines 2 | 3 | Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 4 | documentation, we greatly value feedback and contributions from our community. 5 | 6 | Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 7 | information to effectively respond to your bug report or contribution. 8 | 9 | 10 | ## Reporting Bugs/Feature Requests 11 | 12 | We welcome you to use the GitHub issue tracker to report bugs or suggest features. 13 | 14 | When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already 15 | reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: 16 | 17 | * A reproducible test case or series of steps 18 | * The version of our code being used 19 | * Any modifications you've made relevant to the bug 20 | * Anything unusual about your environment or deployment 21 | 22 | 23 | ## Contributing via Pull Requests 24 | Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: 25 | 26 | 1. You are working against the latest source on the *main* branch. 27 | 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 28 | 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. 29 | 30 | To send us a pull request, please: 31 | 32 | 1. Fork the repository. 33 | 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. 34 | 3. Ensure local tests pass. 35 | 4. Commit to your fork using clear commit messages. 36 | 5. Send us a pull request, answering any default questions in the pull request interface. 37 | 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. 38 | 39 | GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 40 | [creating a pull request](https://help.github.com/articles/creating-a-pull-request/). 41 | 42 | 43 | ## Finding contributions to work on 44 | Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. 45 | 46 | 47 | ## Code of Conduct 48 | This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 49 | For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 50 | opensource-codeofconduct@amazon.com with any additional questions or comments. 51 | 52 | 53 | ## Security issue notifications 54 | If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. 55 | 56 | 57 | ## Licensing 58 | 59 | See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. 60 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # eslint-plugin-no-date-parsing 2 | 3 | Disallow string parsing with new Date and Date.parse. 4 | 5 | ## Why? 6 | 7 | String parsing with `new Date` and `Date.parse` will result in timezone errors if the string does not specify a time zone. 8 | `new Date` and `Date.parse` are not portable as the implementation is not in the ECMA specification and is left to the browser vendor to determine. 9 | 10 | [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date), says 11 | 12 | > Note: Parsing of date strings with the Date constructor (and Date.parse(), which works the same way) is strongly discouraged due to browser differences and inconsistencies. 13 | > 14 | > - Support for RFC 2822 format strings is by convention only. 15 | > - Support for ISO 8601 formats differs in that date-only strings (e.g. "1970-01-01") are treated as UTC, not local. 16 | 17 | Brief illustrations of the issue: 18 | 19 | ``` 20 | dateFns.format(new Date('2020-03-27'), 'yyyy-MM-dd') 21 | "2020-03-26" 22 | 23 | moment(new Date('2020-03-27')).format('YYYY-MM-DD') 24 | "2020-03-26" 25 | ``` 26 | 27 | ## Installation 28 | 29 | ``` 30 | npm install --save-dev eslint-plugin-no-date-parsing 31 | ``` 32 | 33 | **`eslint-plugin-no-date-parsing` version 0:** Supports `eslint` v7 and `@typescript-eslint` v4. 34 | 35 | **`eslint-plugin-no-date-parsing` version 1:** Supports `eslint` v8 and `@typescript-eslint` v5. 36 | 37 | ## Usage 38 | 39 | Add `no-date-parsing` to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix: 40 | 41 | ``` 42 | { 43 | "plugins": [ 44 | "no-date-parsing" 45 | ] 46 | } 47 | ``` 48 | 49 | `no-date-parsing` contains only one rule. Add it under the rules section. 50 | 51 | ``` 52 | { 53 | "rules": { 54 | "no-date-parsing/no-date-parsing": "error" 55 | } 56 | } 57 | ``` 58 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "eslint-plugin-no-date-parsing", 3 | "version": "1.0.1", 4 | "description": "Disallow string parsing with new Date and Date.parse.", 5 | "main": "dist/index.js", 6 | "scripts": { 7 | "prepublish": "tsc -p tsconfig-dist.json", 8 | "test": "ts-node tests/tests.ts" 9 | }, 10 | "author": "Joe Frambach ", 11 | "license": "Apache-2.0", 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/amzn/eslint-plugin-no-date-parsing" 15 | }, 16 | "engines": { 17 | "node": ">=14" 18 | }, 19 | "dependencies": { 20 | "@typescript-eslint/utils": "^5.0.0" 21 | }, 22 | "peerDependencies": { 23 | "@typescript-eslint/parser": "^5.0.0", 24 | "eslint": "^8.0.0" 25 | }, 26 | "devDependencies": { 27 | "@types/node": "~18.11.9", 28 | "@typescript-eslint/parser": "~5.42.0", 29 | "eslint-etc": "~5.2.0", 30 | "ts-node": "~10.9.1", 31 | "typescript": "~4.8.0" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | // SPDX-License-Identifier: Apache-2.0 5 | 6 | module.exports.rules = { 7 | 'no-date-parsing': require('./rules/no-date-parsing') 8 | }; 9 | 10 | module.exports.configs = { 11 | recommended: { 12 | plugins: ["no-date-parsing"], 13 | env: { 14 | browser: true, 15 | }, 16 | rules: { 17 | "no-date-parsing/no-date-parsing": "error", 18 | }, 19 | } 20 | }; 21 | -------------------------------------------------------------------------------- /src/rules/no-date-parsing.ts: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | // SPDX-License-Identifier: Apache-2.0 5 | 6 | import { ESLintUtils, TSESTree } from '@typescript-eslint/utils'; 7 | import { TypeFlags } from 'typescript'; 8 | 9 | const rule = ESLintUtils.RuleCreator(() => 'https://github.com/amzn/eslint-plugin-no-date-parsing')({ 10 | name: 'no-date-parsing', 11 | meta: { 12 | type: 'problem', 13 | docs: { 14 | description: 'Disallow `Date` string parsing', 15 | recommended: 'error' 16 | }, 17 | messages: { 18 | mustBeTyped: 'Argument to `Date` must have a TypeScript type.', 19 | noNewDate: 'Parsing of date strings with `new Date` is strongly discouraged due to browser differences and inconsistencies.', 20 | noDateParse: 'Parsing of date strings with `Date.parse` is strongly discouraged due to browser differences and inconsistencies.' 21 | }, 22 | schema: [] 23 | }, 24 | defaultOptions: [], 25 | create: (context) => { 26 | const { program, esTreeNodeToTSNodeMap } = ESLintUtils.getParserServices(context); 27 | const checker = program.getTypeChecker(); 28 | 29 | /** 30 | * Disallow Date constructor with unknown or non-numeric types 31 | * @param node node to evaluate 32 | */ 33 | function checkConstructor(node: TSESTree.NewExpression | TSESTree.CallExpression) { 34 | const tsNode = esTreeNodeToTSNodeMap.get(node.arguments[0]); 35 | const nodeType = checker.getTypeAtLocation(tsNode); 36 | const constrained = checker.getBaseConstraintOfType(nodeType); 37 | const type = constrained || nodeType; 38 | if (type.flags & TypeFlags.Any || type.flags & TypeFlags.Unknown) { 39 | context.report({ 40 | node, 41 | messageId: 'mustBeTyped' 42 | }); 43 | } else if (!(type.flags & TypeFlags.NumberLike)) { 44 | context.report({ 45 | node, 46 | messageId: 'noNewDate' 47 | }); 48 | } 49 | } 50 | 51 | /** 52 | * Disallow Date.parse 53 | */ 54 | function checkDateParse(node: TSESTree.CallExpression) { 55 | context.report({ 56 | node, 57 | messageId: 'noDateParse' 58 | }); 59 | } 60 | 61 | return { 62 | 'CallExpression[callee.name="Date"][arguments.length!=0]': checkConstructor, 63 | 'NewExpression[callee.name="Date"][arguments.length!=0]': checkConstructor, 64 | 'CallExpression[callee.object.name="Date"][callee.property.name="parse"]': checkDateParse 65 | }; 66 | } 67 | }); 68 | 69 | export = rule; 70 | -------------------------------------------------------------------------------- /tests/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "parserOptions": { 3 | "project": "tsconfig.json" 4 | } 5 | } -------------------------------------------------------------------------------- /tests/tests.ts: -------------------------------------------------------------------------------- 1 | import { createRuleTester } from "eslint-etc"; 2 | import { resolve } from "path"; 3 | 4 | import rule = require('../src/rules/no-date-parsing'); 5 | 6 | createRuleTester({ 7 | filename: resolve("./tests/file.ts") 8 | })({ 9 | types: true 10 | }).run('no-date-parsing', rule, { 11 | valid: [ 12 | 'new Date(2020, 3, 20)', 13 | 'var t = 123456; new Date(t)', 14 | ], 15 | 16 | invalid: [ 17 | { 18 | code: 'new Date("2020-03-20")', 19 | errors: [{messageId: 'noNewDate'}], 20 | }, 21 | { 22 | code: 'Date.parse("2020-03-20")', 23 | errors: [{messageId: 'noDateParse'}], 24 | }, 25 | { 26 | code: 'var x = "2020-03-20"; new Date(x);', 27 | errors: [{messageId: 'noNewDate'}], 28 | }, 29 | { 30 | code: 'var x = "2020-03-20"; Date.parse(x);', 31 | errors: [{messageId: 'noDateParse'}], 32 | }, 33 | { 34 | code: 'function f(x) { new Date(x) }', 35 | errors: [{messageId: 'mustBeTyped'}], 36 | }, 37 | { 38 | code: 'function f(x) { Date.parse(x) }', 39 | errors: [{messageId: 'noDateParse'}], 40 | }, 41 | ], 42 | }); 43 | 44 | console.log('Tests completed successfully'); 45 | -------------------------------------------------------------------------------- /tests/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "lib": ["esnext"], 4 | "module": "commonjs", 5 | "moduleResolution": "node", 6 | "skipLibCheck": true, 7 | "target": "esnext" 8 | }, 9 | "files": ["file.ts"] 10 | } -------------------------------------------------------------------------------- /tsconfig-dist.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "outDir": "dist" 4 | }, 5 | "extends": "./tsconfig.json", 6 | "include": [ 7 | "src/**/*.ts" 8 | ] 9 | } -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "declaration": false, 5 | "esModuleInterop": true, 6 | "importHelpers": true, 7 | "lib": ["esnext"], 8 | "module": "commonjs", 9 | "moduleResolution": "node", 10 | "noEmitHelpers": true, 11 | "outDir": "build", 12 | "paths": {}, 13 | "removeComments": true, 14 | "skipLibCheck": true, 15 | "sourceMap": false, 16 | "strict": true, 17 | "target": "es2018" 18 | }, 19 | "include": ["src/**/*.ts", "tests/**/*.ts"], 20 | "exclude": [] 21 | } --------------------------------------------------------------------------------