enable additional lint rules and fix

Author: autopulated

eslint.config.js

@@ -46,15 +46,15 @@ js.configs.recommended,
         "block-scoped-var": 2,
         "callback-return": 2,
         "default-case": 2,
-        "semi": 2
+        "semi": 2,
+        "quotes": [2, "single", { "avoidEscape": true }]
+    }
+},
+{
+    files: ["lib/*"],
+    rules: {
+        "no-shadow":2,
     }
 },
-// {
-//     files: ["lib/*"],
-//     rules: {
-//         "no-shadow":2,
-//         "quotes": [2, "single", { "avoidEscape": true }]
-//     }
-// },
 ];
 

lib/model.js

@@ -60,7 +60,7 @@ const deepCloneObjectsAndArrays = (v) => {
     if (Array.isArray(v)) {
         return v.map(deepCloneObjectsAndArrays);
     } else if ((v?.constructor === Object) || (v instanceof BaseModel)) {
-        return Object.fromEntries(Object.entries(v).map(([k,v]) => [k, deepCloneObjectsAndArrays(v)]));
+        return Object.fromEntries(Object.entries(v).map(([k2,v2]) => [k2, deepCloneObjectsAndArrays(v2)]));
     } else {
         return v;
     }
@@ -774,7 +774,7 @@ class BaseModel {
         // { key1: {$between: [v1, v2]}} -> {key: key1, values: [v1, v2], condition: '$between'}
         return Object.entries(queryObject).map( ([k,v]) => {
             if (typeof v === 'object') {
-                const conditions = Object.keys(v).filter(k => k.startsWith('$'));
+                const conditions = Object.keys(v).filter(k2 => k2.startsWith('$'));
                 if (conditions.length > 1) {
                     throw new Error(`Only a single ${[...supportedQueryConditions.keys()].join('/')} condition is supported in the simple query api.`);
                 } else if (conditions.length === 1) {

lib/schema.js

@@ -47,10 +47,10 @@ const attributeTypeFromSchema = (indexName, schema, propertyName) => {
     throw new Error(`The schema type of property .${propertyName}, "${JSON.stringify(schema?.properties?.[propertyName])}" used by index "${indexName}" is not indexable.`);
 };
 
-const parseIndexSpecification = (index, schemaSource) => {
-    if (!index) return [];
+const parseIndexSpecification = (indexSpecs, schemaSource) => {
+    if (!indexSpecs) return [];
     const indices = [];
-    for (const [indexName, indexSpec] of Object.entries(index)) {
+    for (const [indexName, indexSpec] of Object.entries(indexSpecs)) {
         if (!validIndexName.exec(indexName)) {
             throw new Error(`Invalid index name "${indexName}": Must be between 3 and 255 characters long, and may contain only the characters a-z, A-Z, 0-9, '_', '-', and '.'.`);
         }

test/crud.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 
 const clientOptions = {
     endpoint: 'http://localhost:8000'
@@ -7,7 +7,7 @@ const clientOptions = {
 const DynamoDMConstructor = require('../');
 const DynamoDM = DynamoDMConstructor({clientOptions, logger:{level:'error'}});
 
-t.test('crud:', async t => {
+tap.test('crud:', async t => {
     const table = DynamoDM.Table({ name: 'test-table-crud'});
     const ThingSchema = DynamoDM.Schema('namespace.thing', {
         properties: {
@@ -161,4 +161,4 @@ t.test('crud:', async t => {
     t.end();
 });
 
-t.end();
+tap.end();

test/model.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 
 const clientOptions = {
     endpoint: 'http://localhost:8000'
@@ -7,7 +7,7 @@ const clientOptions = {
 const DynamoDMConstructor = require('../');
 const DynamoDM = DynamoDMConstructor({clientOptions, logger:{level:'error'}});
 
-t.test('model:', async t => {
+tap.test('model:', async t => {
     const table = DynamoDM.Table({ name: 'test-table-models'});
     const FooSchema = DynamoDM.Schema('namespace.foo', {
         properties: {
@@ -179,3 +179,5 @@ t.test('model:', async t => {
         t.end();
     });
 });
+
+tap.end();

test/multi.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 
 const clientOptions = {
     endpoint: 'http://localhost:8000'
@@ -14,13 +14,13 @@ const DynamoDMConstructor2 = require('../');
 const DynamoDM1 = DynamoDMConstructor1({clientOptions, logger:{level:'error'}});
 const DynamoDM2 = DynamoDMConstructor2({clientOptions, logger:{level:'error'}});
 
-t.test('unique identity', async t => {
+tap.test('unique identity', async t => {
     t.ok(DynamoDMConstructor1 !== DynamoDMConstructor2, "check that we've created separate module instances for testing");
     t.notOk(DynamoDM1.Schema('test') instanceof DynamoDM2.Schema('test').constructor, 'check that Schema types are unique');
 });
 
 
-t.test('crud with schema from separate module', async t => {
+tap.test('crud with schema from separate module', async t => {
     const table = DynamoDM1.Table({ name: 'test-table-multi-crud'});
     const ThingSchema = DynamoDM2.Schema('namespace.thing', {
         properties: {
@@ -76,4 +76,4 @@ t.test('crud with schema from separate module', async t => {
     t.end();
 });
 
-t.end();
+tap.end();

test/queries.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 
 const clientOptions = {
     endpoint: 'http://localhost:8000'
@@ -15,7 +15,7 @@ async function arrayFromAsync(iter) {
     return r;
 }
 
-t.test('queries:', async t => {
+tap.test('queries:', async t => {
     const table = DynamoDM.Table({ name: 'test-table-queries'});
     const FooSchema = DynamoDM.Schema('namespace.foo', {
         properties: {
@@ -709,7 +709,7 @@ t.test('queries:', async t => {
     t.end();
 });
 
-t.test('largeQueries', async t => {
+tap.test('largeQueries', async t => {
     const table = DynamoDM.Table({ name: 'test-table-largequeries'});
     const XSchema = DynamoDM.Schema('x', {
         properties: {
@@ -763,3 +763,5 @@ t.test('largeQueries', async t => {
     });
 
 });
+
+tap.end();

test/schemas.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 
 const clientOptions = {
     endpoint: 'http://localhost:8000'
@@ -7,7 +7,7 @@ const clientOptions = {
 const DynamoDMConstructor = require('../');
 const DynamoDM = DynamoDMConstructor({clientOptions, logger:{level:'error'}});
 
-t.test('basic schemas:', async t => {
+tap.test('basic schemas:', async t => {
     const table = DynamoDM.Table({ name: 'test-table-schemas'});
 
     await t.test('empty schema', async t => {
@@ -303,7 +303,7 @@ t.test('basic schemas:', async t => {
     });
 });
 
-t.test('virtuals:', async t => {
+tap.test('virtuals:', async t => {
     t.test('string aliases', async t => {
         const table = DynamoDM.Table({ name: 'test-table-2'});
         const ASchema = DynamoDM.Schema('virtualsA', {
@@ -467,7 +467,7 @@ t.test('virtuals:', async t => {
     });
 });
 
-t.test('converters:', async t => {
+tap.test('converters:', async t => {
     t.test('sync field creation and deletion', async t => {
         const table = DynamoDM.Table({ name: 'test-table-2'});
         const ASchema = DynamoDM.Schema('testConverters', {
@@ -553,7 +553,7 @@ t.test('converters:', async t => {
     });
 });
 
-t.test('custom field names', async t => {
+tap.test('custom field names', async t => {
     const table = DynamoDM.Table({ name: 'test-table-custom-names'});
 
     // models should have default .id, .type, .createdAt, .updatedAt properties
@@ -577,7 +577,7 @@ t.test('custom field names', async t => {
     t.equal(doc.myVersion, 1);
 });
 
-t.test('versioning', async t => {
+tap.test('versioning', async t => {
     const logger = require('pino')({level:'warn'});
     // stop child logger creation so we can intercept messages
     logger.child = () => { return logger; };
@@ -784,7 +784,7 @@ t.test('versioning', async t => {
     });
 });
 
-t.test('schema errors', async t => {
+tap.test('schema errors', async t => {
     const table = DynamoDM.Table({ name: 'test-table-schemas'});
 
     const AStringSchema            = DynamoDM.Schema('namespace.thing', { properties: { a: {type: 'string'}, } });
@@ -938,4 +938,4 @@ t.test('schema errors', async t => {
     });
 });
 
-t.end();
+tap.end();

test/table.js

@@ -1,4 +1,4 @@
-const t = require('tap');
+const tap = require('tap');
 const { DescribeTableCommand } = require('@aws-sdk/client-dynamodb');
 
 const clientOptions = {
@@ -8,10 +8,9 @@ const clientOptions = {
 const DynamoDMConstructor = require('../');
 const DynamoDM = DynamoDMConstructor({clientOptions, logger:{level:'error'}});
 
-t.pass('import ok');
+tap.pass('import ok');
 
-t.test('incorrect usage throws', async t => {
-    const DynamoDMConstructor = require('../');
+tap.test('incorrect usage throws', async t => {
     t.throws(() => {
         DynamoDMConstructor.Table({name: 'test-table-1'});
     }, {message: "DynamoDM must be called as a function to get an instance of the API, e.g. const DynamoDM = require('dynamodm')(options);"}, 'DynamoDM.Table() throws');
@@ -21,7 +20,7 @@ t.test('incorrect usage throws', async t => {
     }, {message: "DynamoDM must be called as a function to get an instance of the API, e.g. const DynamoDM = require('dynamodm')(options);"}, 'DynamoDM.Schema() throws');
 });
 
-t.test('table initialisation', async t => {
+tap.test('table initialisation', async t => {
     await t.test('create without schemas', async t => {
         const table = DynamoDM.Table({ name: 'test-table-1', clientOptions});
         await t.rejects(table.ready());
@@ -73,7 +72,7 @@ t.test('table initialisation', async t => {
     });
 });
 
-t.test('waiting for table creation', async t => {
+tap.test('waiting for table creation', async t => {
     const table = DynamoDM.Table({ name: 'test-table-slow-creation', clientOptions});
     table.model(DynamoDM.Schema('emptySchema'));
 
@@ -101,7 +100,7 @@ t.test('waiting for table creation', async t => {
     t.equal(commandSendResults().length, 3, 'Should wait for success.');
 });
 
-t.test('waiting for table UPDATING', async t => {
+tap.test('waiting for table UPDATING', async t => {
     const table = DynamoDM.Table({ name: 'test-table-slow-creation', clientOptions});
     table.model(DynamoDM.Schema('emptySchema'));
 
@@ -142,7 +141,7 @@ t.test('waiting for table UPDATING', async t => {
     t.equal(commandSendResults().length, 2, 'UPDATING should be considered created, requiring only two responses.');
 });
 
-t.test('table consistency:', async t => {
+tap.test('table consistency:', async t => {
     t.test('throws on inconsistent id field names', async t => {
         const table = DynamoDM.Table({ name: 'test-table-errors'});
         table.model(DynamoDM.Schema('schema1'));
@@ -282,7 +281,7 @@ t.test('table consistency:', async t => {
     t.end();
 });
 
-t.test('index creation fails', async t => {
+tap.test('index creation fails', async t => {
     const Schema1_noIndexes = DynamoDM.Schema('1', {
         properties: {
             aString: {type:'string'},
@@ -342,7 +341,7 @@ t.test('index creation fails', async t => {
     t.end();
 });
 
-t.test('wait for index creation', async t => {
+tap.test('wait for index creation', async t => {
     const Schema1_noIndexes = DynamoDM.Schema('1', {
         properties: {
             aString: {type:'string'},
@@ -394,7 +393,7 @@ t.test('wait for index creation', async t => {
     t.end();
 });
 
-t.test("don't wait for index creation", async t => {
+tap.test("don't wait for index creation", async t => {
     const Schema1_noIndexes = DynamoDM.Schema('1', {
         properties: {
             aString: {type:'string'},
@@ -445,4 +444,4 @@ t.test("don't wait for index creation", async t => {
     t.end();
 });
 
-t.end();
+tap.end();