Version 1.7.1

.editorconfig

@@ -86,7 +86,7 @@ indent_style = space
 indent_size = 2
 
 # Kotlin
-# https://android.github.io/kotlin-guides/style.html#indentation
+# https://kotlinlang.org/docs/coding-conventions.html#indentation
 [*.{kt,kts}]
 indent_size = 4
 indent_style = space

.github/workflows/ci.yml

@@ -9,11 +9,6 @@ on:
     branches:
       - main
   pull_request:
-    paths-ignore:
-      - '**/README.md'
-      - '**/LICENSE.md'
-      - '**/.*'
-      - docs/**
 
 # Cancel previous runs of the same workflow on the same branch.
 concurrency:

.gitignore

@@ -288,5 +288,3 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/Node,Windows,Linux,macOS,VisualStudioCode,C
-
-package.json.backup

.vscode/settings.json

@@ -4,11 +4,13 @@
   "explorer.fileNesting.patterns": {
     "*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
     "*.mjs": "${capture}.mjs.map, ${capture}.min.mjs, ${capture}.d.mts",
+    "*.cjs": "${capture}.cjs.map, ${capture}.min.cjs, ${capture}.d.cts",
     ".npmrc": ".nvmrc, .yarnrc.yml",
     ".gitignore": ".eslintignore, .prettierignore",
     "README.md": "CONTRIBUTING.md, CODE_OF_CONDUCT.md",
     "LICENSE.md": "PREAMBLE",
     "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, pnpm-workspace.yaml, .pnp.cjs, .pnp.loader.mjs, .eslintcache",
     "tsconfig.json": "tsconfig.*.json"
-  }
+  },
+  "cSpell.words": ["ENULL", "Hardlink", "Spacedrive"]
 }

babel.config.json

@@ -0,0 +1,11 @@
+{
+  "plugins": ["@babel/plugin-syntax-import-attributes", "@babel/plugin-proposal-json-modules"],
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "shippedProposals": true
+      }
+    ]
+  ]
+}

docs/archive-wasm/functions/extract.md

@@ -6,7 +6,7 @@
 
 > **extract**(`data`, `opts`?): `Generator`\<[`Entry`](../interfaces/Entry.md), `void`, `void`\>
 
-Uncompress archive and iterate through all it's entries
+Extract archive and iterate through all it's entries
 
 ## Parameters
 

docs/archive-wasm/functions/extractAll.md

@@ -6,7 +6,7 @@
 
 > **extractAll**(`data`, `opts`?): [`Entry`](../interfaces/Entry.md)[]
 
-Uncompress all entries in an archive
+Extract all entries in an archive
 
 > This function is the preferred choice over `extract` when your use case
 > involves accessing the content data of all entries within the archive,

docs/archive-wasm/interfaces/ExtractOpts.md

@@ -10,7 +10,7 @@
 
 > **encoding**: `undefined` \| `string`
 
-Encoding to be used to parse entry's metada. Defaults to 'utf8'
+Encoding to be used to parse entry's metadata. Defaults to 'utf8'
 
 ---
 

eslint-local-rules.cjs

@@ -18,7 +18,7 @@
 
 'use strict'
 
-module.exports = {
+module.exports = /** @type { Record<string, import('eslint').Rule.RuleModule> } */ ({
   'disallow-jsdoc-typedef': {
     meta: {
       type: 'problem',
@@ -48,4 +48,4 @@ module.exports = {
       }
     },
   },
-}
+})

eslint.config.mjs

@@ -0,0 +1,158 @@
+/*!
+ * archive-wasm - LibArchive compiled to WASM with a idiomatic JS API
+ * Copyright (C) 2023 Spacedrive Technology Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import babelParser from '@babel/eslint-parser'
+import babel from '@babel/eslint-plugin'
+import jsdoc from 'eslint-plugin-jsdoc'
+import licenseHeader from 'eslint-plugin-license-header'
+import localRules from 'eslint-plugin-local-rules'
+import prettier from 'eslint-plugin-prettier/recommended'
+import globals from 'globals'
+import neostandard, { plugins, resolveIgnoresFromGitignore } from 'neostandard'
+
+/** @type { import('eslint').Linter.Config[] } */
+export default [
+  ...neostandard({
+    ts: true,
+    noStyle: true,
+    ignores: [...resolveIgnoresFromGitignore(), 'src/wasm/libarchive.mjs'],
+  }),
+  {
+    plugins: { localRules, licenseHeader },
+    rules: {
+      'licenseHeader/header': ['error', 'PREAMBLE'],
+    },
+  },
+  plugins.n.configs['flat/recommended-module'],
+  {
+    files: ['**/*.js', '**/*.mjs'],
+    plugins: { babel },
+    languageOptions: {
+      parser: babelParser,
+      parserOptions: {
+        requireConfigFile: false,
+      },
+    },
+  },
+  {
+    ...plugins.n.configs['flat/recommended-script'],
+    files: ['**/*.cjs'],
+  },
+  plugins.promise.configs['flat/recommended'],
+  {
+    files: ['**/*.js', '**/*.mjs', '**/*.cjs'],
+    ...jsdoc.configs['flat/recommended-typescript-flavor'],
+    rules: {
+      ...jsdoc.configs['flat/recommended-typescript-flavor'].rules,
+      'jsdoc/require-returns-check': 'off',
+      'jsdoc/require-param-description': 'off',
+      'jsdoc/require-returns-description': 'off',
+    },
+  },
+  ...[
+    ...plugins['typescript-eslint'].configs.strictTypeChecked,
+    ...plugins['typescript-eslint'].configs.stylisticTypeChecked,
+  ].map(conf => ({
+    ...conf,
+    files: ['**/*.ts', '**/*.d.ts', '**/*.d.mts', '**/*.d.cts'],
+    languageOptions: {
+      ...(conf.languageOptions ?? {}),
+      parserOptions: {
+        ...(conf.parserOptions ?? {}),
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  })),
+  {
+    files: ['**/*.ts', '**/*.d.ts', '**/*.d.mts', '**/*.d.cts'],
+    rules: {
+      'n/no-unpublished-import': [
+        'error',
+        {
+          ignoreTypeImport: true,
+        },
+      ],
+      '@typescript-eslint/no-extra-semi': 'off',
+      '@typescript-eslint/unbound-method': [
+        'error',
+        {
+          ignoreStatic: true,
+        },
+      ],
+      '@typescript-eslint/no-explicit-any': [
+        'error',
+        {
+          fixToUnknown: true,
+        },
+      ],
+      'no-use-before-define': 'off',
+      '@typescript-eslint/no-use-before-define': [
+        'error',
+        {
+          ignoreTypeReferences: true,
+        },
+      ],
+      '@typescript-eslint/explicit-function-return-type': [
+        'error',
+        {
+          allowConciseArrowFunctionExpressionsStartingWithVoid: true,
+        },
+      ],
+    },
+  },
+  {
+    files: ['*.d.ts', '**/*.d.mts'],
+    rules: {
+      'localRules/disallow-jsdoc-typedef': 'error',
+      '@typescript-eslint/no-unused-vars': 'off',
+    },
+  },
+  {
+    files: ['src/wasm/libarchive.mjs', 'src/wasm/libarchive.d.mts'],
+    rules: {
+      'licenseHeader/header': 'off',
+      'padding-line-between-statements': [
+        'error',
+        {
+          blankLine: 'always',
+          prev: '*',
+          next: 'export',
+        },
+      ],
+    },
+  },
+  {
+    files: ['src/**/*.mjs'],
+    ignores: ['src/fs.mjs', 'src/wasm/libarchive.mjs'],
+    languageOptions: {
+      globals: {
+        ...globals['shared-node-browser'],
+        ...globals.es2022,
+      },
+    },
+  },
+  {
+    files: ['**/*'],
+    rules: {
+      'no-void': ['error', { allowAsStatement: true }],
+      'n/no-missing-import': 'off',
+    },
+  },
+  prettier,
+]