chore: add lint-eslint.yml

Signed-off-by: John Molakvoæ <[email protected]>
Signed-off-by: John Molakvoæ <[email protected]>

.eslintignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+	extends: [
+		'@nextcloud/eslint-config/typescript',
+	],
+	settings: {
+		jsdoc: {
+			mode: 'typescript',
+		},
+	},
+}

.github/workflows/lint-eslint.yml

@@ -0,0 +1,62 @@
+# This workflow is provided via the organization template repository
+#
+# https://github.com/nextcloud/.github
+# https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
+#
+# Use lint-eslint together with lint-eslint-when-unrelated to make eslint a required check for GitHub actions
+# https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks#handling-skipped-but-required-checks
+
+name: Lint eslint
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/**'
+      - 'src/**'
+      - 'appinfo/info.xml'
+      - 'package.json'
+      - 'package-lock.json'
+      - 'tsconfig.json'
+      - '.eslintrc.*'
+      - '.eslintignore'
+      - '**.js'
+      - '**.ts'
+      - '**.vue'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: lint-eslint-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    name: eslint
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+
+      - name: Read package.json node and npm engines version
+        uses: skjnldsv/read-package-engines-version-actions@8205673bab74a63eb9b8093402fd9e0e018663a1 # v2.2
+        id: versions
+        with:
+          fallbackNode: '^20'
+          fallbackNpm: '^9'
+
+      - name: Set up node ${{ steps.versions.outputs.nodeVersion }}
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+        with:
+          node-version: ${{ steps.versions.outputs.nodeVersion }}
+
+      - name: Set up npm ${{ steps.versions.outputs.npmVersion }}
+        run: npm i -g npm@"${{ steps.versions.outputs.npmVersion }}"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint

__tests__/fileAction.spec.ts

@@ -1,5 +1,8 @@
+/* eslint-disable no-new */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import { getFileActions, registerFileAction, FileAction } from '../lib/fileAction'
-import logger from '../lib/utils/logger';
+import logger from '../lib/utils/logger'
 
 describe('FileActions init', () => {
 
@@ -165,7 +168,7 @@ describe('Invalid FileAction creation', () => {
 				iconSvgInline: () => '<svg></svg>',
 				exec: async () => true,
 				inline: () => true,
-				renderInline: false
+				renderInline: false,
 			} as any as FileAction)
 		}).toThrowError('Invalid renderInline function')
 	})
@@ -202,4 +205,4 @@ describe('FileActions creation', () => {
 		expect(action.inline?.({} as any, {})).toBe(true)
 		expect(action.renderInline?.({} as any, {}).outerHTML).toBe('<span>test</span>')
 	})
-})
+})

__tests__/files/file.spec.ts

@@ -40,7 +40,7 @@ describe('File creation', () => {
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg',
 			mime: 'image/jpeg',
 			owner: 'emma',
-			root: '/files/emma'
+			root: '/files/emma',
 		})
 
 		expect(file).toBeInstanceOf(File)
@@ -66,7 +66,7 @@ describe('File creation', () => {
 		const file = new File({
 			source: 'https://domain.com/Photos/picture.jpg',
 			mime: 'image/jpeg',
-			owner: null
+			owner: null,
 		})
 
 		expect(file).toBeInstanceOf(File)
@@ -154,7 +154,7 @@ describe('File data change', () => {
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg',
 			mime: 'image/jpeg',
 			owner: 'emma',
-			root: '/files/emma'
+			root: '/files/emma',
 		})
 
 		expect(file.basename).toBe('picture.jpg')
@@ -170,7 +170,6 @@ describe('File data change', () => {
 	})
 })
 
-
 describe('Altering attributes updates mtime', () => {
 	test('mtime is updated on existing attribute', () => {
 		const file = new File({
@@ -179,12 +178,12 @@ describe('Altering attributes updates mtime', () => {
 			owner: 'emma',
 			mtime: new Date(Date.UTC(1990, 0, 1, 0, 0, 0)),
 			attributes: {
-				test: true
+				test: true,
 			},
 		})
 		expect(file.attributes.test).toBe(true)
 		file.attributes.test = false
-	
+
 		// Check that mtime has been updated
 		expect(file.mtime?.getDate()).toBe(new Date().getDate())
 		expect(file.attributes.test).toBe(false)
@@ -199,7 +198,7 @@ describe('Altering attributes updates mtime', () => {
 		})
 		expect(file.attributes.test).toBeFalsy()
 		file.attributes.test = true
-	
+
 		// Check that mtime has been updated
 		expect(file.mtime?.getDate()).toBe(new Date().getDate())
 		expect(file.attributes.test).toBe(true)
@@ -212,12 +211,12 @@ describe('Altering attributes updates mtime', () => {
 			owner: 'emma',
 			mtime: new Date(Date.UTC(1990, 0, 1, 0, 0, 0)),
 			attributes: {
-				test: true
+				test: true,
 			},
 		})
 		expect(file.attributes.test).toBe(true)
 		delete file.attributes.test
-	
+
 		// Check that mtime has been updated
 		expect(file.mtime?.getDate()).toBe(new Date().getDate())
 		expect(file.attributes.test).toBeUndefined()

__tests__/files/folder.spec.ts

@@ -6,7 +6,7 @@ describe('Folder creation', () => {
 	test('Valid dav folder', () => {
 		const folder = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/',
-			owner: 'emma'
+			owner: 'emma',
 		})
 
 		expect(folder).toBeInstanceOf(Folder)
@@ -31,7 +31,7 @@ describe('Folder creation', () => {
 		const folder = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/Berlin',
 			owner: 'emma',
-			root: '/files/emma'
+			root: '/files/emma',
 		})
 
 		expect(folder).toBeInstanceOf(Folder)
@@ -55,7 +55,7 @@ describe('Folder creation', () => {
 	test('Valid remote folder', () => {
 		const folder = new Folder({
 			source: 'https://domain.com/Photos/',
-			owner: null
+			owner: null,
 		})
 
 		expect(folder).toBeInstanceOf(Folder)
@@ -81,7 +81,7 @@ describe('Folder data change', () => {
 	test('Rename a folder', () => {
 		const folder = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos',
-			owner: 'emma'
+			owner: 'emma',
 		})
 
 		expect(folder.basename).toBe('Photos')
@@ -99,7 +99,7 @@ describe('Folder data change', () => {
 	test('Moving a folder', () => {
 		const folder = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/',
-			owner: 'emma'
+			owner: 'emma',
 		})
 
 		expect(folder.basename).toBe('Photos')
@@ -118,7 +118,7 @@ describe('Folder data change', () => {
 		const folder = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/',
 			owner: 'emma',
-			root: '/files/emma'
+			root: '/files/emma',
 		})
 
 		expect(folder.basename).toBe('Photos')

__tests__/files/node.spec.ts

@@ -8,23 +8,23 @@ describe('Node testing', () => {
 		const file = new File({
 			source: 'https://cloud.domain.com/remote.php/dav/picture.jpg',
 			mime: 'image/jpeg',
-			owner: 'emma'
+			owner: 'emma',
 		})
 		expect(file.root).toBeNull()
 	})
 
 	test('Remove source ending slash', () => {
 		const file = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/',
-			owner: 'emma'
+			owner: 'emma',
 		})
 		expect(file.source).toBe('https://cloud.domain.com/remote.php/dav/files/emma/Photos')
 	})
 
 	test('Invalid rename', () => {
 		const file = new Folder({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/',
-			owner: 'emma'
+			owner: 'emma',
 		})
 		expect(() => file.rename('new/folder')).toThrowError('Invalid basename')
 	})
@@ -35,7 +35,7 @@ describe('FileId attribute', () => {
 		const file = new File({
 			source: 'https://cloud.domain.com/remote.php/dav/picture.jpg',
 			mime: 'image/jpeg',
-			owner: 'emma'
+			owner: 'emma',
 		})
 		expect(file.fileid).toBeUndefined()
 	})
@@ -46,8 +46,8 @@ describe('FileId attribute', () => {
 			mime: 'image/jpeg',
 			owner: 'emma',
 			attributes: {
-				fileid: 1234
-			}
+				fileid: 1234,
+			},
 		})
 		expect(file.fileid).toBe(1234)
 	})
@@ -75,17 +75,17 @@ describe('Sanity checks', () => {
 		expect(() => new File({
 			source: 'cloud.domain.com/remote.php/dav/Photos',
 			mime: 'image/jpeg',
-			owner: 'emma'
+			owner: 'emma',
 		})).toThrowError('Invalid source')
 		expect(() => new File({
 			source: '/remote.php/dav/files/emma/Photos/picture.jpg',
 			mime: 'image/jpeg',
-			owner: 'emma'
+			owner: 'emma',
 		})).toThrowError('Invalid source format, source must be a valid URL')
 		expect(() => new File({
 			source: 'ftp://remote.php/dav/files/emma/Photos/picture.jpg',
 			mime: 'image/jpeg',
-			owner: 'emma'
+			owner: 'emma',
 		})).toThrowError('Invalid source format, only http(s) is supported')
 	})
 
@@ -94,25 +94,24 @@ describe('Sanity checks', () => {
 			source: 'https://cloud.domain.com/remote.php/dav/Photos',
 			mime: 'image',
 			owner: 'emma',
-			mtime: 'invalid' as unknown as Date
+			mtime: 'invalid' as unknown as Date,
 		})).toThrowError('Invalid mtime type')
 	})
 
-
 	test('Invalid crtime', () => {
 		expect(() => new File({
 			source: 'https://cloud.domain.com/remote.php/dav/Photos',
 			mime: 'image',
 			owner: 'emma',
-			crtime: 'invalid' as unknown as Date
+			crtime: 'invalid' as unknown as Date,
 		})).toThrowError('Invalid crtime type')
 	})
 
 	test('Invalid mime', () => {
 		expect(() => new File({
 			source: 'https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg',
 			mime: 'image',
-			owner: 'emma'
+			owner: 'emma',
 		})).toThrowError('Missing or invalid mandatory mime')
 	})