Merge pull request #1720 from stripe/richardm-lint-extensions

Require `.js` extension via linter rule

.eslintrc.js

@@ -44,6 +44,7 @@ module.exports = {
     'id-blacklist': 'error',
     'id-length': 'off',
     'id-match': 'error',
+    'import/extensions': ['error', 'ignorePackages'],
     'init-declarations': 'off',
     'jsx-quotes': 'error',
     'key-spacing': 'error',
@@ -241,7 +242,7 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2018,
   },
-  plugins: ['prettier'],
+  plugins: ['prettier', 'import'],
   extends: ['plugin:prettier/recommended'],
   overrides: [
     {

package.json

@@ -39,6 +39,7 @@
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-chai-friendly": "^0.7.2",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^3.4.1",
     "mocha": "^8.4.0",
     "mocha-junit-reporter": "^2.1.0",

test/Error.spec.ts

@@ -2,7 +2,7 @@
 
 require('./testUtils.js');
 
-import * as Error from '../src/Error';
+import * as Error from '../cjs/Error.js';
 import {expect} from 'chai';
 
 describe('Error', () => {

test/PlatformFunctions.spec.ts

@@ -5,12 +5,12 @@ require('./testUtils.js');
 import * as fs from 'fs';
 import * as path from 'path';
 
-import {FetchHttpClient} from '../cjs/net/FetchHttpClient';
-import {NodeCryptoProvider} from '../cjs/crypto/NodeCryptoProvider';
-import {NodeHttpClient} from '../cjs/net/NodeHttpClient';
-import {NodePlatformFunctions} from '../cjs/platform/NodePlatformFunctions';
-import {PlatformFunctions} from '../cjs/platform/PlatformFunctions';
-import {SubtleCryptoProvider} from '../cjs/crypto/SubtleCryptoProvider';
+import {FetchHttpClient} from '../cjs/net/FetchHttpClient.js';
+import {NodeCryptoProvider} from '../cjs/crypto/NodeCryptoProvider.js';
+import {NodeHttpClient} from '../cjs/net/NodeHttpClient.js';
+import {NodePlatformFunctions} from '../cjs/platform/NodePlatformFunctions.js';
+import {PlatformFunctions} from '../cjs/platform/PlatformFunctions.js';
+import {SubtleCryptoProvider} from '../cjs/crypto/SubtleCryptoProvider.js';
 
 import {expect} from 'chai';
 import {webcrypto} from 'crypto';
@@ -21,7 +21,7 @@ if (process.versions.node < '15') {
   );
 } else {
   import(
-    '../cjs/platform/WebPlatformFunctions'
+    '../cjs/platform/WebPlatformFunctions.js'
   ).then(({WebPlatformFunctions}) => testPlatform(new WebPlatformFunctions()));
 }
 

test/RequestSender.spec.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const {RequestSender} = require('../cjs/RequestSender');
+const {RequestSender} = require('../cjs/RequestSender.js');
 
 const stripe = require('./testUtils.js').getSpyableStripe();
 const expect = require('chai').expect;
 
-const {HttpClientResponse} = require('../cjs/net/HttpClient');
+const {HttpClientResponse} = require('../cjs/net/HttpClient.js');
 const utils = require('./testUtils.js');
 const nock = require('nock');
 
@@ -16,7 +16,7 @@ const {
   StripeRateLimitError,
   StripeError,
   StripeConnectionError,
-} = require('../cjs/Error');
+} = require('../cjs/Error.js');
 describe('RequestSender', () => {
   const sender = new RequestSender(stripe, 0);
 
@@ -88,7 +88,7 @@ describe('RequestSender', () => {
 
   describe('Parameter encoding', () => {
     // Use a real instance of stripe as we're mocking the http.request responses.
-    const realStripe = require('../cjs/stripe.cjs.node')(
+    const realStripe = require('../cjs/stripe.cjs.node.js')(
       utils.getUserStripeKey()
     );
 
@@ -337,7 +337,7 @@ describe('RequestSender', () => {
 
   describe('Retry Network Requests', () => {
     // Use a real instance of stripe as we're mocking the http.request responses.
-    const realStripe = require('../cjs/stripe.cjs.node')(
+    const realStripe = require('../cjs/stripe.cjs.node.js')(
       utils.getUserStripeKey()
     );
 

test/StripeResource.spec.js

@@ -6,7 +6,7 @@ const stripe = require('./testUtils.js').getSpyableStripe();
 const expect = require('chai').expect;
 const testUtils = require('./testUtils.js');
 
-const {StripeResource} = require('../cjs/StripeResource');
+const {StripeResource} = require('../cjs/StripeResource.js');
 const stripeMethod = StripeResource.method;
 
 describe('StripeResource', () => {
@@ -107,7 +107,7 @@ describe('StripeResource', () => {
     };
 
     it('is not impacted by the global host', (done) => {
-      const stripe = require('../cjs/stripe.cjs.node')('sk_test', {
+      const stripe = require('../cjs/stripe.cjs.node.js')('sk_test', {
         host: 'bad.host.stripe.com',
       });
 
@@ -122,7 +122,7 @@ describe('StripeResource', () => {
     });
 
     it('still lets users override the host on a per-request basis', (done) => {
-      const stripe = require('../cjs/stripe.cjs.node')('sk_test');
+      const stripe = require('../cjs/stripe.cjs.node.js')('sk_test');
 
       const scope = nock('https://some.other.host.stripe.com')
         .get('/v1/resourceWithHost')

test/Webhook.spec.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-const {StripeSignatureVerificationError} = require('../cjs/Error');
+const {StripeSignatureVerificationError} = require('../cjs/Error.js');
 const {getSpyableStripe, FakeCryptoProvider} = require('./testUtils.js');
 const stripe = getSpyableStripe();
 import {expect} from 'chai';

test/autoPagination.spec.js

@@ -3,9 +3,9 @@
 /* eslint-disable callback-return */
 
 const testUtils = require('./testUtils.js');
-const {StripeResource} = require('../cjs/StripeResource');
+const {StripeResource} = require('../cjs/StripeResource.js');
 
-const {makeAutoPaginationMethods} = require('../cjs/autoPagination');
+const {makeAutoPaginationMethods} = require('../cjs/autoPagination.js');
 
 const expect = require('chai').expect;
 

test/crypto/NodeCryptoProvider.spec.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const {NodeCryptoProvider} = require('../../cjs/crypto/NodeCryptoProvider');
+const {NodeCryptoProvider} = require('../../cjs/crypto/NodeCryptoProvider.js');
 
-const {createCryptoProviderTestSuite} = require('./helpers');
+const {createCryptoProviderTestSuite} = require('./helpers.js');
 
 describe('NodeCryptoProvider', () => {
   createCryptoProviderTestSuite(new NodeCryptoProvider());

test/crypto/SubtleCryptoProvider.spec.js

@@ -1,6 +1,8 @@
 'use strict';
 
-const {SubtleCryptoProvider} = require('../../cjs/crypto/SubtleCryptoProvider');
+const {
+  SubtleCryptoProvider,
+} = require('../../cjs/crypto/SubtleCryptoProvider.js');
 const webcrypto = require('crypto').webcrypto;
 const expect = require('chai').expect;
 
@@ -10,7 +12,7 @@ if (!webcrypto || !webcrypto.subtle) {
     `Skipping SubtleCryptoProvider tests. No 'webcrypto.subtle' available for ${process.version}.`
   );
 } else {
-  const {createCryptoProviderTestSuite} = require('./helpers');
+  const {createCryptoProviderTestSuite} = require('./helpers.js');
 
   describe('SubtleCryptoProvider', () => {
     const provider = new SubtleCryptoProvider(webcrypto.subtle);

test/flows.spec.ts

@@ -2,7 +2,7 @@
 
 const testUtils = require('./testUtils.js');
 const chai = require('chai');
-const stripe = require('../cjs/stripe.cjs.node')(
+const stripe = require('../cjs/stripe.cjs.node.js')(
   testUtils.getUserStripeKey(),
   'latest'
 );

test/net/FetchHttpClient.spec.js

@@ -4,13 +4,13 @@ const expect = require('chai').expect;
 const fetch = require('node-fetch');
 const nock = require('nock');
 const {Readable} = require('stream');
-const {FetchHttpClient} = require('../../cjs/net/FetchHttpClient');
+const {FetchHttpClient} = require('../../cjs/net/FetchHttpClient.js');
 
 const createFetchHttpClient = () => {
   return new FetchHttpClient(fetch);
 };
 
-const {createHttpClientTestSuite, ArrayReadable} = require('./helpers');
+const {createHttpClientTestSuite, ArrayReadable} = require('./helpers.js');
 
 describe('FetchHttpClient', () => {
   createHttpClientTestSuite(createFetchHttpClient, (setupNock, sendRequest) => {

test/net/NodeHttpClient.spec.js

@@ -3,9 +3,9 @@
 const http = require('http');
 const expect = require('chai').expect;
 
-const {createNodeHttpClient} = require('../../cjs/stripe.cjs.node');
+const {createNodeHttpClient} = require('../../cjs/stripe.cjs.node.js');
 
-const {createHttpClientTestSuite, ArrayReadable} = require('./helpers');
+const {createHttpClientTestSuite, ArrayReadable} = require('./helpers.js');
 
 describe('NodeHttpClient', () => {
   createHttpClientTestSuite(createNodeHttpClient, (setupNock, sendRequest) => {

test/net/helpers.js

@@ -5,7 +5,7 @@ const {Readable} = require('stream');
 const nock = require('nock');
 const expect = require('chai').expect;
 
-const utils = require('../../cjs/utils');
+const utils = require('../../cjs/utils.js');
 const {fail} = require('assert');
 
 /**

test/stripe.spec.ts

@@ -2,14 +2,14 @@
 
 'use strict';
 
-import {FetchHttpClient} from '../cjs/net/FetchHttpClient';
-import {NodeHttpClient} from '../cjs/net/NodeHttpClient';
-import {createStripe} from '../cjs/stripe.core';
+import {FetchHttpClient} from '../cjs/net/FetchHttpClient.js';
+import {NodeHttpClient} from '../cjs/net/NodeHttpClient.js';
+import {createStripe} from '../cjs/stripe.core.js';
 import {getMockPlatformFunctions} from './testUtils.js';
 
 const testUtils = require('./testUtils.js');
-const Stripe = require('../cjs/stripe.cjs.node');
-const stripe = require('../cjs/stripe.cjs.node')(
+const Stripe = require('../cjs/stripe.cjs.node.js');
+const stripe = require('../cjs/stripe.cjs.node.js')(
   testUtils.getUserStripeKey(),
   'latest'
 );

test/telemetry.spec.js

@@ -57,7 +57,7 @@ describe('Client Telemetry', () => {
         res.end('{}');
       },
       (host, port) => {
-        const stripe = require('../cjs/stripe.cjs.node')(
+        const stripe = require('../cjs/stripe.cjs.node.js')(
           'sk_test_FEiILxKZwnmmocJDUjUNO6pa',
           {
             telemetry: false,
@@ -107,7 +107,7 @@ describe('Client Telemetry', () => {
         res.end('{}');
       },
       (host, port) => {
-        const stripe = require('../cjs/stripe.cjs.node')(
+        const stripe = require('../cjs/stripe.cjs.node.js')(
           'sk_test_FEiILxKZwnmmocJDUjUNO6pa',
           {
             telemetry: true,
@@ -159,7 +159,7 @@ describe('Client Telemetry', () => {
         res.end('{}');
       },
       (host, port) => {
-        const stripe = require('../cjs/stripe.cjs.node')(
+        const stripe = require('../cjs/stripe.cjs.node.js')(
           'sk_test_FEiILxKZwnmmocJDUjUNO6pa',
           {
             telemetry: true,

test/testUtils.js

@@ -8,13 +8,13 @@ require('chai').use(require('chai-as-promised'));
 
 const http = require('http');
 
-const {CryptoProvider} = require('../cjs/crypto/CryptoProvider');
+const {CryptoProvider} = require('../cjs/crypto/CryptoProvider.js');
 const {
   NodePlatformFunctions,
-} = require('../cjs/platform/NodePlatformFunctions');
-const {RequestSender} = require('../cjs/RequestSender');
-const {createStripe} = require('../cjs/stripe.core');
-const stripe = require('../cjs/stripe.cjs.node');
+} = require('../cjs/platform/NodePlatformFunctions.js');
+const {RequestSender} = require('../cjs/RequestSender.js');
+const {createStripe} = require('../cjs/stripe.core.js');
+const stripe = require('../cjs/stripe.cjs.node.js');
 
 const testingHttpAgent = new http.Agent({keepAlive: false});
 
@@ -30,7 +30,7 @@ const utils = (module.exports = {
     });
     server.listen(0, () => {
       const {port} = server.address();
-      const stripe = require('../cjs/stripe.cjs.node')(
+      const stripe = require('../cjs/stripe.cjs.node.js')(
         module.exports.getUserStripeKey(),
         {
           host: 'localhost',
@@ -47,7 +47,7 @@ const utils = (module.exports = {
   },
 
   getStripeMockClient: () => {
-    const stripe = require('../cjs/stripe.cjs.node');
+    const stripe = require('../cjs/stripe.cjs.node.js');
 
     return stripe('sk_test_123', {
       host: process.env.STRIPE_MOCK_HOST || 'localhost',
@@ -187,7 +187,7 @@ const utils = (module.exports = {
 
     // Provide a testable stripe instance
     // That is, with mock-requests built in and hookable
-    const stripe = require('../cjs/stripe.cjs.node');
+    const stripe = require('../cjs/stripe.cjs.node.js');
     const stripeInstance = stripe('fakeAuthToken', config);
 
     stripeInstance.REQUESTS = [];
@@ -211,7 +211,7 @@ const utils = (module.exports = {
     function CleanupUtility(timeout) {
       const self = this;
       this._cleanupFns = [];
-      this._stripe = require('../cjs/stripe.cjs.node')(
+      this._stripe = require('../cjs/stripe.cjs.node.js')(
         utils.getUserStripeKey(),
         'latest'
       );

test/utils.spec.ts

@@ -2,7 +2,7 @@
 
 require('./testUtils.js');
 
-import * as utils from '../cjs/utils';
+import * as utils from '../cjs/utils.js';
 import {expect} from 'chai';
 
 describe('utils', () => {