@superblocksteam/sabs-client 0.127.0

package/eslint.config.mjs

@@ -0,0 +1,261 @@
+import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import _import from 'eslint-plugin-import';
+import prettier from 'eslint-plugin-prettier';
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+});
+
+export default [
+  {
+    // Ignore Jest configuration file (it's excluded from tsconfig.json, so it's problematic!)
+    ignores: [
+      'coverage/*',
+      'dist/*',
+      'eslint.config.mjs',
+      '**/jest.config.js'
+    ]
+  },
+  ...fixupConfigRules(
+    compat.extends(
+      'eslint:recommended',
+      'plugin:@typescript-eslint/eslint-recommended',
+      'plugin:@typescript-eslint/recommended',
+      'plugin:@typescript-eslint/recommended-requiring-type-checking',
+      'plugin:import/typescript',
+      'prettier',
+      'plugin:prettier/recommended'
+    )
+  ),
+  {
+    plugins: {
+      '@typescript-eslint': fixupPluginRules(typescriptEslint),
+      import: fixupPluginRules(_import),
+      prettier: fixupPluginRules(prettier)
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+        ...globals.node
+      },
+
+      parser: tsParser,
+      ecmaVersion: 2020,
+      sourceType: 'commonjs',
+
+      parserOptions: {
+        impliedStrict: true,
+        project: './**/tsconfig.json'
+      }
+    },
+
+    settings: {
+      'import/parsers': {
+        '@typescript-eslint/parser': ['.ts', '.tsx']
+      },
+
+      'import/resolver': {
+        node: {},
+
+        typescript: {
+          project: './**/tsconfig.json'
+        }
+      }
+    },
+
+    // Custom Configurations
+    rules: {
+      'prettier/prettier': ['error'],
+
+      '@typescript-eslint/array-type': [
+        'error',
+        {
+          default: 'array-simple',
+          readonly: 'array-simple'
+        }
+      ],
+
+      '@typescript-eslint/await-thenable': ['error'],
+      '@typescript-eslint/explicit-module-boundary-types': ['off'],
+      '@typescript-eslint/explicit-member-accessibility': ['error'],
+
+      '@typescript-eslint/member-ordering': [
+        'error',
+        {
+          default: ['static-field', 'static-method', 'instance-field', 'constructor', 'instance-method']
+        }
+      ],
+
+      '@typescript-eslint/no-empty-function': [
+        'error',
+        {
+          allow: ['constructors']
+        }
+      ],
+
+      '@typescript-eslint/no-floating-promises': ['error'],
+      '@typescript-eslint/no-for-in-array': ['error'],
+      '@typescript-eslint/no-misused-promises': ['error'],
+      '@typescript-eslint/no-require-imports': ['error'],
+      '@typescript-eslint/no-unsafe-assignment': ['off'],
+      '@typescript-eslint/no-unsafe-call': ['off'],
+      '@typescript-eslint/no-unsafe-member-access': ['off'],
+      '@typescript-eslint/no-unsafe-return': ['off'],
+
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          vars: 'all',
+          varsIgnorePattern: '^_'
+        }
+      ],
+
+      '@typescript-eslint/no-useless-constructor': ['error'],
+      '@typescript-eslint/prefer-for-of': ['error'],
+
+      '@typescript-eslint/prefer-nullish-coalescing': [
+        'error',
+        {
+          ignoreMixedLogicalExpressions: true
+        }
+      ],
+
+      '@typescript-eslint/prefer-readonly': ['error'],
+
+      '@typescript-eslint/promise-function-async': [
+        'error',
+        {
+          checkArrowFunctions: false
+        }
+      ],
+
+      '@typescript-eslint/restrict-template-expressions': [
+        'error',
+        {
+          allowNumber: true,
+          allowBoolean: true,
+          allowAny: true,
+          allowNullish: true
+        }
+      ],
+
+      '@typescript-eslint/require-await': ['error'],
+      '@typescript-eslint/return-await': ['error', 'in-try-catch'],
+      '@typescript-eslint/switch-exhaustiveness-check': ['error'],
+      complexity: ['off'],
+      'dot-notation': ['error'],
+
+      eqeqeq: [
+        'error',
+        'always',
+        {
+          null: 'ignore'
+        }
+      ],
+
+      'import/no-duplicates': ['error'],
+
+      'import/no-extraneous-dependencies': [
+        'error',
+        {
+          devDependencies: ['**/test/**', '**/*.test.ts'], // Only allow importing devDependencies from tests
+          optionalDependencies: false, // Disallow importing optional dependencies (those shouldn't be used here)
+          peerDependencies: false // Disallow importing peer dependencies (those shouldn't be used here)
+        }
+      ],
+
+      'import/no-unresolved': [
+        'error',
+        {
+          ignore: [
+            '@jsii/check-node/run', // @jsii/check-node uses an export map, which import/resolver does not (yet) support (https://github.com/import-js/eslint-plugin-import/issues/1868)
+            'worker_threads' // This isn't supported in all node versions (import is always guarded)
+          ]
+        }
+      ],
+
+      'import/order': [
+        'error',
+        {
+          alphabetize: {
+            order: 'asc',
+            caseInsensitive: true
+          },
+
+          groups: [
+            ['builtin', 'external'],
+            ['parent', 'sibling'],
+            ['index', 'unknown']
+          ],
+          'newlines-between': 'always'
+        }
+      ],
+
+      'no-alert': ['error'],
+      'no-await-in-loop': ['error'],
+      'no-caller': ['error'],
+
+      'no-else-return': [
+        'error',
+        {
+          allowElseIf: true
+        }
+      ],
+
+      'no-eval': ['error'],
+      'no-extra-bind': ['error'],
+      'no-implied-eval': ['error'],
+      'no-lone-blocks': ['error'],
+      'no-new-symbol': ['error'],
+      'no-proto': ['error'],
+
+      'no-restricted-properties': [
+        'error',
+        {
+          property: 'substr',
+          message: 'Use .slice instead of .substr.'
+        }
+      ],
+
+      'no-return-await': ['error'],
+      'no-unused-expressions': ['error'],
+      'no-useless-call': ['error'],
+      'no-var': ['error'],
+      'prefer-const': ['error'],
+      'prefer-template': ['error'],
+      'eol-last': ['error', 'always'],
+      // Disabled rules
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-use-before-define': 'off',
+      '@typescript-eslint/unbound-method': 'off',
+      'no-case-declarations': 'off',
+      'require-atomic-updates': 'off',
+      // This is not a bad rule but it got sprung on us and our code loudly fails it
+      // Disable to get the eslint upgrade to pass.
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      // 'consistent-return' actually decreases safety. Its use will enforce useless `throws`
+      // statements, forcing a runtime error that occlude cases where the TypeScript type
+      // checker would actually have caught something like a non-exhaustive `switch` statement
+      // at compile time.
+      'consistent-return': 'off'
+    }
+  }
+];

package/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  roots: ['<rootDir>/'],
+  transform: {
+    '^.+\\.(ts|tsx)$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.test.json' }],
+  },
+  testRegex: '(/__tests__/.*|(\\.)(test|spec))\\.tsx?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node', 'css'],
+  moduleDirectories: ['node_modules', 'src'],
+  transformIgnorePatterns: [],
+  modulePathIgnorePatterns: ['<rootDir>/dist/__mocks__/'],
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.test.{js,jsx,ts,tsx}'],
+  testEnvironment: 'node'
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@superblocksteam/sabs-client",
+  "version": "v0.127.0",
+  "description": "Superblocks Application Build System Client for TypeScript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/superblocksteam/sabs.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "Superblocks Community Software License",
+  "scripts": {
+    "build": "pnpm install && pnpm run lint:fix && tsc",
+    "clean": "npx rimraf ./dist ./coverage *tsbuildinfo",
+    "lint": "eslint . --ext ts --max-warnings 0 --cache --cache-strategy content --cache-location ~/.cache/eslint/",
+    "lint:fix": "eslint . --ext ts --fix --cache --cache-strategy content --cache-location ~/.cache/eslint/",
+    "lint:precommit": "eslint --ext ts --fix --cache --cache-strategy content --cache-location ~/.cache/eslint/",
+    "test": "echo $SPEC_PATH && echo $TEST_NAME && jest -i ./${SPEC_PATH} -t ${TEST_NAME}",
+    "test:coverage": "echo $SPEC_PATH && echo $TEST_NAME && jest --coverage --coverageReporters=text-summary json-summary lcov -i ./${SPEC_PATH} -t ${TEST_NAME}"
+  },
+  "dependencies": {
+    "@superblocksteam/sabs-types": "^0.127.0",
+    "axios": "^1.8.3"
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.26.0",
+    "@eslint/compat": "^1.2.7",
+    "@eslint/eslintrc": "3.3.1",
+    "@eslint/js": "^9.22.0",
+    "@side/jest-runtime": "^1.1.0",
+    "@types/jest": "^29.2.6",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
+    "eslint": "^9.22.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-prettier": "5.2.3",
+    "globals": "16.0.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.3",
+    "rimraf": "6.0.1",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "typescript": "5.8.3",
+    "typescript-eslint": "^8.26.1"
+  },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "pnpm lint:precommit"
+    ]
+  },
+  "engines": {
+    "node": "^20.11.1",
+    "pnpm": "^10.6.2"
+  },
+  "packageManager": "pnpm@10.6.3+sha512.bb45e34d50a9a76e858a95837301bfb6bd6d35aea2c5d52094fa497a467c43f5c440103ce2511e9e0a2f89c3d6071baac3358fc68ac6fb75e2ceb3d2736065e6"
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './sabs';