Updated eslint config and README.

pauldenver · Jul 20, 2022 · 3db8c58 · 3db8c58
1 parent 848c382
commit 3db8c58
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 18 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -18,12 +18,14 @@ module.exports = {
       ignoreStrings: true,
       ignoreTemplateLiterals: true,
     }],
+    'semi': [ 'error', 'always' ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
   overrides: [
     {
       files: [ 'test/generate_api_key.spec.ts' ],
       rules: {
+        '@typescript-eslint/no-var-requires': 'off',
         '@typescript-eslint/ban-ts-comment': [
           'error',
           {

diff --git a/README.md b/README.md
@@ -53,10 +53,24 @@ generation methods, such as `string`, `bytes`, `base32`, `base62`, `uuidv4`, and
 `uuidv5`. The `string` method is used by default.  
 <br />
 
+Importing:  
+
+```javascript
+// CommonJS Import
+const { generateApiKey } = require('generate-api-key');
+// OR
+const generateApiKey = require('generate-api-key').default;
+
+// ES6 Import
+import { generateApiKey } from 'generate-api-key';
+// OR
+import generateApiKey from 'generate-api-key';
+```
+
 Example:
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Generate the API key.
 generateApiKey(); // ⇨ 'q_EaTiX+xbBXLyO05.+zDXjI+Qi_X0v'
@@ -95,7 +109,7 @@ Creates an API key/access token using random string generation.
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Generate the API key. The 'string' method is used by default.
 generateApiKey(); // ⇨ 'q_EaTiX+xbBXLyO05.+zDXjI+Qi_X0v'
@@ -147,7 +161,7 @@ Creates an API key/access token using random bytes.
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Provide the generation method.
 generateApiKey({ method: 'bytes' }); // ⇨ '6f31bfc3717d63e7bd21'
@@ -188,7 +202,7 @@ Creates an API key/access token using a random UUID and converting it into a [Do
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Provide the generation method.
 generateApiKey({ method: 'base32' }); // ⇨ '2NOLH5I-43EEK7A-R6YRK3I-BRCIQNQ'
@@ -225,7 +239,7 @@ Creates an API key using Base62 encoding.
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Provide the generation method.
 generateApiKey({ method: 'base62' }); // ⇨ '2AEmXhHtNJkIAqL1S3So6G'
@@ -260,7 +274,7 @@ Creates an API key/access token using random UUID Version 4 generation.
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Provide the generation method.
 generateApiKey({ method: 'uuidv4' }); // ⇨ 'c40c974f-307e-490e-8d4e-0c8f31f21df3'
@@ -300,7 +314,7 @@ Creates an API key/access token using random UUID Version 5 generation.
 Examples:  
 
 ```javascript
-const generateApiKey = require('generate-api-key');
+import generateApiKey from 'generate-api-key';
 
 // Provide the generation method with the name and namespace.
 generateApiKey({

diff --git a/dist/generate_api_key.d.ts.map b/dist/generate_api_key.d.ts.map
diff --git a/dist/generate_api_key.js.map b/dist/generate_api_key.js.map
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -1,3 +1,3 @@
-export { generateApiKey } from './generate_api_key';
+export { generateApiKey, default } from './generate_api_key';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map
diff --git a/dist/index.d.ts.map b/dist/index.d.ts.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/generate_api_key.ts b/src/generate_api_key.ts
@@ -186,7 +186,7 @@ const getUuidV4ApiKey = (options: UuidV4GenerationOptions): string => {
 
   // Check if we should remove dashes.
   return (!options.dashes) ? apiKey.replace(/-/g, '') : apiKey;
-}
+};
 
 /**
  * Creates an API key using random UUID Version 5 generation.
@@ -230,7 +230,7 @@ const getUuidV5ApiKey = (options: UuidV5GenerationOptions): string => {
 
   // Check if we should remove dashes.
   return (!options.dashes) ? apiKey.replace(/-/g, '') : apiKey;
-}
+};
 
 /**
  * Generates a simple API key or a batch of API keys based on 
@@ -287,6 +287,6 @@ export const generateApiKey = (options: GenerationOptions = {}): ApiKeyResults =
     // Add a prefix if necessary.
     return (options.prefix) ? `${options.prefix}.${apiKey}` : apiKey;
   }
-}
+};
 
 export default generateApiKey;
diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,2 @@
-export { generateApiKey } from './generate_api_key';
+export { generateApiKey, default } from './generate_api_key';
 export * from './types';
diff --git a/test/generate_api_key.spec.ts b/test/generate_api_key.spec.ts
@@ -319,4 +319,15 @@ describe('generateApiKey', () => {
       batch: [],
     })).to.throw(TypeError, `The 'batch' option must be a natural number > 0.`);
   });
+
+  context(`should import 'generateApiKey' as a default import`, () => {
+    const generateApiKeyDefault = shouldTestBuild
+      ? require('../dist/index').default
+      : require('../src').default;
+
+    // Create the API key.
+    const apiKey = generateApiKeyDefault();
+
+    expect(apiKey).to.be.a('string');
+  });
 });