feat: added @matrixai/lint and removed old linting elements, ran linting with js-lint

Author: CDeltakai

.eslintrc

@@ -2,12 +2,12 @@
 
 Encrypted filesystem library for TypeScript/JavaScript applications
 
-* Virtualised - files, directories, permissions are all virtual constructs, they do not correspond to real filesystems
-* Orthogonally Persistent - all writes automatically persisted
-* Encrypted-At-Rest - all persistence is encrypted
-* Random Read & Write - encryption and decryption operates over fixed-block sizes
-* Streamable - files do not need to loaded fully in-memory
-* Comprehensive continuous benchmarks in CI/CD
+- Virtualised - files, directories, permissions are all virtual constructs, they do not correspond to real filesystems
+- Orthogonally Persistent - all writes automatically persisted
+- Encrypted-At-Rest - all persistence is encrypted
+- Random Read & Write - encryption and decryption operates over fixed-block sizes
+- Streamable - files do not need to loaded fully in-memory
+- Comprehensive continuous benchmarks in CI/CD
 
 Development based on js-virtualfs: https://github.com/MatrixAI/js-virtualfs
 
@@ -34,7 +34,7 @@ const efs = await EncryptedFS.createEncryptedFS({
 
 // optionally set up the worker manager for multi-threaded encryption/decryption
 const workerManager = await WorkerManager.createWorkerManager<EFSWorkerModule>({
-  workerFactory: () => spawn(new Worker('./src/workers/efsWorker'))
+  workerFactory: () => spawn(new Worker('./src/workers/efsWorker')),
 });
 
 efs.setWorkerManager(workerManager);
@@ -64,10 +64,10 @@ Internally we use the AES-GCM symmetric encryption using a master `dbKey` that c
 
 The `dbKey` can be generated from several methods:
 
-* `generateKey` - random asynchronous
-* `generateKeySync` - random synchronous
-* `generateKeyFromPass` - derived from user-provided "password" asynchronous
-* `generateKeyFromPassSync` - derived from user-provided "password" synchronous
+- `generateKey` - random asynchronous
+- `generateKeySync` - random synchronous
+- `generateKeyFromPass` - derived from user-provided "password" asynchronous
+- `generateKeyFromPassSync` - derived from user-provided "password" synchronous
 
 For example:
 
@@ -95,9 +95,9 @@ The ciphertext data length is equal to the plaintext block length.
 
 There are some differences between EFS and Node FS:
 
-* User, Group and Other permissions: In EFS User, Group and Other permissions are strictly confined to their permission class. For example, a User in EFS does not have the permissions that a Group or Other has while in Node FS a User also has permissions that Group and Other have.
-* Sticky Files: In Node FS, a sticky bit is a permission bit that is set on a file or a directory that lets only the owner of the file/directory or the root user to delete or rename the file. EFS does not support the use of sticky bits.
-* Character Devices: Node FS contains Character Devices which can be written to and read from. However, in EFS Character Devices are not supported yet.
+- User, Group and Other permissions: In EFS User, Group and Other permissions are strictly confined to their permission class. For example, a User in EFS does not have the permissions that a Group or Other has while in Node FS a User also has permissions that Group and Other have.
+- Sticky Files: In Node FS, a sticky bit is a permission bit that is set on a file or a directory that lets only the owner of the file/directory or the root user to delete or rename the file. EFS does not support the use of sticky bits.
+- Character Devices: Node FS contains Character Devices which can be written to and read from. However, in EFS Character Devices are not supported yet.
 
 ## Development
 

README.md

@@ -52,9 +52,8 @@
     "ts-node": "ts-node",
     "tsx": "tsx",
     "test": "node ./scripts/test.mjs",
-    "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}'",
-    "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}' --fix",
-    "lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
+    "lint": "matrixai-lint",
+    "lintfix": "matrixai-lint --fix",
     "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
     "bench": "tsc -p ./tsconfig.build.json && shx rm -rf ./benches/results && tsx ./benches/index.ts"
   },
@@ -74,21 +73,17 @@
     "util-callbackify": "^1.0.0"
   },
   "devDependencies": {
+    "@matrixai/lint": "^0.1.0",
     "@fast-check/jest": "^2.1.0",
     "@swc/core": "1.3.82",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.5.7",
     "@types/node-forge": "^1.0.2",
     "@types/readable-stream": "^2.3.11",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
     "benny": "^3.7.1",
     "common-tags": "^1.8.2",
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^5.0.0-alpha.2",
+    "eslint": "^9.0.0",
     "fast-check": "^4.0.0",
     "jest": "^29.6.2",
     "jest-extended": "^4.0.0",

package-lock.json

@@ -1,4 +1,4 @@
 export { default as FileDescriptorManager } from './FileDescriptorManager.js';
 export { default as FileDescriptor } from './FileDescriptor.js';
 export * as errors from './errors.js';
-export * from './types.js';
+export type * from './types.js';

package.json

@@ -6,4 +6,4 @@ export * as inodes from './inodes/index.js';
 export * as constants from './constants.js';
 export * as permissions from './permissions.js';
 export * as utils from './utils.js';
-export * from './types.js';
+export type * from './types.js';

src/fd/index.ts

@@ -1,4 +1,4 @@
 export { default as INodeManager } from './INodeManager.js';
-export * from './types.js';
+export type * from './types.js';
 export * as utils from './utils.js';
 export * as errors from './errors.js';

src/index.ts

@@ -1,3 +1,3 @@
 export { default as ReadStream } from './ReadStream.js';
 export { default as WriteStream } from './WriteStream.js';
-export * from './types.js';
+export type * from './types.js';