refactor: support inrupt coding standards

CommunitySolidServer · May 25, 2020 · f8e136c · f8e136c
1 parent 5def531
commit f8e136c
Show file tree

Hide file tree

Showing 25 changed files with 722 additions and 604 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -6,21 +6,16 @@ module.exports = {
     project: ['./tsconfig.json'],
   },
   plugins: [
-    '@typescript-eslint',
     'prettier',
     'eslint-plugin-tsdoc',
   ],
   extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'es/node',
     'prettier', // disables rules from the above that conflict with prettier
     'plugin:prettier/recommended', // adds prettier rules
   ],
   rules: {
     '@typescript-eslint/no-empty-interface': 'off',
-    'prettier/prettier': 'error',
     "sort-imports": "error",
     'tsdoc/syntax': 'error',
   },

diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@ coverage
 *.d.ts
 
 !.eslintrc.js
+!test/eslintrc.js
 !jest.config.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,9 +7,19 @@
   "scripts": {
     "build": "tsc",
     "lint": "eslint . --ext .ts",
-    "prepare": "npm run lint && npm run build",
     "test": "jest"
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint && npm run build"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "src/**/*.js",
+    "src/**/*.d.ts"
+  ],
   "dependencies": {
     "@rdfjs/data-model": "^1.1.2",
     "@types/jest": "^25.2.1",
@@ -20,11 +30,12 @@
     "@typescript-eslint/eslint-plugin": "^2.33.0",
     "@typescript-eslint/parser": "^2.33.0",
     "eslint": "^7.0.0",
+    "eslint-config-es": "^3.19.61",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.3",
     "eslint-plugin-tsdoc": "^0.2.4",
+    "husky": "^4.2.5",
     "jest": "^26.0.1",
-    "pre-commit": "^1.2.2",
     "prettier": "^2.0.5",
     "ts-jest": "^25.5.1",
     "typescript": "^3.9.2"

diff --git a/lib/ldp/http/BinaryRepresentation.ts → src/ldp/http/BinaryRepresentation.ts b/lib/ldp/http/BinaryRepresentation.ts → src/ldp/http/BinaryRepresentation.ts
diff --git a/lib/ldp/http/NamedRepresentation.ts → src/ldp/http/NamedRepresentation.ts b/lib/ldp/http/NamedRepresentation.ts → src/ldp/http/NamedRepresentation.ts
diff --git a/lib/ldp/http/Patch.ts → src/ldp/http/Patch.ts b/lib/ldp/http/Patch.ts → src/ldp/http/Patch.ts
diff --git a/lib/ldp/http/QuadRepresentation.ts → src/ldp/http/QuadRepresentation.ts b/lib/ldp/http/QuadRepresentation.ts → src/ldp/http/QuadRepresentation.ts
diff --git a/lib/ldp/http/Representation.ts → src/ldp/http/Representation.ts b/lib/ldp/http/Representation.ts → src/ldp/http/Representation.ts
diff --git a/lib/ldp/http/RepresentationMetadata.ts → src/ldp/http/RepresentationMetadata.ts b/lib/ldp/http/RepresentationMetadata.ts → src/ldp/http/RepresentationMetadata.ts
diff --git a/lib/ldp/http/RepresentationPreferences.ts → src/ldp/http/RepresentationPreferences.ts b/lib/ldp/http/RepresentationPreferences.ts → src/ldp/http/RepresentationPreferences.ts
diff --git a/lib/ldp/http/ResourceIdentifier.ts → src/ldp/http/ResourceIdentifier.ts b/lib/ldp/http/ResourceIdentifier.ts → src/ldp/http/ResourceIdentifier.ts
diff --git a/lib/ldp/operations/Operation.ts → src/ldp/operations/Operation.ts b/lib/ldp/operations/Operation.ts → src/ldp/operations/Operation.ts
diff --git a/lib/ldp/operations/OperationHandler.ts → src/ldp/operations/OperationHandler.ts b/lib/ldp/operations/OperationHandler.ts → src/ldp/operations/OperationHandler.ts
diff --git a/lib/server/HttpHandler.ts → src/server/HttpHandler.ts b/lib/server/HttpHandler.ts → src/server/HttpHandler.ts
diff --git a/lib/storage/AtomicResourceStore.ts → src/storage/AtomicResourceStore.ts b/lib/storage/AtomicResourceStore.ts → src/storage/AtomicResourceStore.ts
diff --git a/lib/storage/Conditions.ts → src/storage/Conditions.ts b/lib/storage/Conditions.ts → src/storage/Conditions.ts
diff --git a/lib/storage/Lock.ts → src/storage/Lock.ts b/lib/storage/Lock.ts → src/storage/Lock.ts
diff --git a/lib/storage/RepresentationConverter.ts → src/storage/RepresentationConverter.ts b/lib/storage/RepresentationConverter.ts → src/storage/RepresentationConverter.ts
diff --git a/lib/storage/ResourceLocker.ts → src/storage/ResourceLocker.ts b/lib/storage/ResourceLocker.ts → src/storage/ResourceLocker.ts
diff --git a/lib/storage/ResourceMapper.ts → src/storage/ResourceMapper.ts b/lib/storage/ResourceMapper.ts → src/storage/ResourceMapper.ts
diff --git a/lib/storage/ResourceStore.ts → src/storage/ResourceStore.ts b/lib/storage/ResourceStore.ts → src/storage/ResourceStore.ts
diff --git a/test/.eslintrc.js b/test/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  env: {
+    jest: true
+  }
+};
diff --git a/test/index.ts b/test/index.ts
@@ -1,5 +1,5 @@
-describe('A basic test', () => {
-  it('to have something pass', () => {
+describe('A basic test', (): void => {
+  it('to have something pass.', async (): Promise<void> => {
     expect(true).toBeTruthy();
   });
 });
diff --git a/tsconfig.json b/tsconfig.json
@@ -10,10 +10,11 @@
     "noImplicitThis": true,
     "noUnusedLocals": true,
     "preserveConstEnums": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "stripInternal": true
   },
   "include": [
-    "lib/**/*.ts",
+    "src/**/*.ts",
     "test/**/*.ts"
   ],
   "exclude": [