Merge pull request #7452 from nextcloud/chore/organize-imports

Use prettier everywhere

Author: max-nextcloud

.eslintrc.cjs

@@ -5,17 +5,14 @@
 
 module.exports = {
 	root: true,
-	extends: [
-		'@nextcloud',
-		'prettier',
-	],
-	"overrides": [
+	extends: ['@nextcloud', 'prettier'],
+	overrides: [
 		{
-			"files": ["**/*.vue"],
-			"rules": {
-				"vue/first-attribute-linebreak": "off"
-			}
-		}
+			files: ['**/*.vue'],
+			rules: {
+				'vue/first-attribute-linebreak': 'off',
+			},
+		},
 	],
 	rules: {
 		'import/no-unresolved': [1, { ignore: ['\\.svg\\?raw$'] }],

.git-blame-ignore-revs

@@ -6,3 +6,5 @@
 
 # Introduce prettier
 810eb74a3f5502ef6485efdda7066c6848878bff
+0d4ada6304f951cdf28b2d045f7fc56629807c11
+eef5dde0838f4e80a420eec19442f9d73533e413

.prettierignore

@@ -10,9 +10,21 @@
 **/node_modules
 **/vendor
 
-# Compiled JS output
+# Compiled output
 js/
+css/
 
 # PHP
 lib/
-**/*.php
+**/*.php
+composer/
+composer.lock
+
+# Translations
+l10n/
+
+# Github files
+.github/
+
+# Test fixtures
+**/fixtures

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.0.2
 
 ### Fixed
+
 - Improved dynamic chunk loading
 - Add translations and fix wording for menu bar icons
 - Fix network error handling
@@ -12,10 +13,12 @@
 ## 1.0.1
 
 ### Added
+
 - Implement proper plain text handling
 - Add translations
 
 ### Fixed
+
 - Fix document loading caused by wrong step order
 - Properly register file action when viewer is disabled
 - Require at least 16.0.1

README.md

@@ -2,12 +2,13 @@
   - SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
+
 # Nextcloud Text
+
 [![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/text)](https://api.reuse.software/info/github.com/nextcloud/text)
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nextcloud/text/node.yml?branch=main)
 [![Start contributing](https://img.shields.io/github/issues/nextcloud/text/good%20first%20issue?color=7057ff&label=Contribute)](https://github.com/nextcloud/text/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
 
-
 **📑 Collaborative document editing!**
 
 ![](img/screenshots/screenshot1.png)
@@ -51,20 +52,20 @@ To use the advantages of `vite serve` with hot module replacement (HMR) and not
 
 1. Configure your webserver to redirect requests to `/apps/text/` to the vite serve server.
    When using [nextcloud-docker-dev](https://github.com/juliusknorr/nextcloud-docker-dev), add the following snippet to `data/nginx/vhost.d/nextcloud.local` and restart the proxy container. You might have to replace `/apps/text/` with e.g. `/apps-extra/text/` depending on where the text app resides in your dev setup.
-   ```
-   location /apps/text/ {
-       proxy_pass http://host.docker.internal:5173/apps/text/;
-       # fallback to nextcloud server if vite serve doesn't answer
-       error_page 502 = @fallback;
-   }
-   location @fallback {
-       proxy_pass http://nextcloud.local;
-   }
-   ```
+    ```
+    location /apps/text/ {
+        proxy_pass http://host.docker.internal:5173/apps/text/;
+        # fallback to nextcloud server if vite serve doesn't answer
+        error_page 502 = @fallback;
+    }
+    location @fallback {
+        proxy_pass http://nextcloud.local;
+    }
+    ```
 2. Run `npm run serve` to start the vite serve server. If text resides somewhere else than `/apps/text`, run e.g. `BASE=/apps-extra/text npm run serve`.
 
 Afterwards all changes to the code will apply to the application in your browser automatically thanks to hot module replacement (HMR).
-   
+
 ### 🧙 Advanced development stuff
 
 To build the Javascript whenever you make changes, instead of the full `make` you can also run `npm run build`. Or run `npm run watch` to rebuild on every file save.
@@ -90,7 +91,6 @@ Or you might set the `CYPRESS_baseUrl` environment variable for a custom nextclo
 - Once that is there, please open a pull request to add them to https://github.com/nextcloud/text/blob/12df66ffdd3d71cc696438e2e4ec60fa17b89a64/src/helpers/mime.js#L35-L61
 - You can test them like other mime types in cypress/e2e/files.spec.js
 
-
 ## 🛠️ Integrate text in your app
 
 ## Load the editor
@@ -111,7 +111,6 @@ if (class_exists(LoadEditor::class)) {
 
 Make sure to check if OCA.Text is available as the Text app needs to be enabled. If you want your app to work without Text being installed, you will need to provide an editor fallback on your own.
 
-
 ```js
 window.OCA.Text.createEditor({
 	el: document.getElementById('my-editor-div'),

codecov.yml

@@ -1,8 +1,8 @@
 coverage:
-  status:
-    project:
-      default:
-        threshold: 0
-        paths:
-          - "src"
-        only_pulls: true
+    status:
+        project:
+            default:
+                threshold: 0
+                paths:
+                    - 'src'
+                only_pulls: true

cypress.config.mjs

@@ -3,12 +3,12 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+import vue from '@vitejs/plugin-vue2'
 import { defineConfig } from 'cypress'
 import cypressSplit from 'cypress-split'
 import { configureVisualRegression } from 'cypress-visual-regression/dist/plugin'
 import vitePreprocessor from 'cypress-vite'
 import { nodePolyfills } from 'vite-plugin-node-polyfills'
-import vue from '@vitejs/plugin-vue2'
 
 export default defineConfig({
 	projectId: 'hx9gqy',
@@ -25,17 +25,22 @@ export default defineConfig({
 			visualRegressionType: 'regression',
 		},
 		setupNodeEvents(on, config) {
-			on('file:preprocessor', vitePreprocessor({
-				plugins: [vue(), nodePolyfills()],
-				configFile: false,
-			}))
+			on(
+				'file:preprocessor',
+				vitePreprocessor({
+					plugins: [vue(), nodePolyfills()],
+					configFile: false,
+				}),
+			)
 			cypressSplit(on, config)
 			configureVisualRegression(on)
 
 			// Disable spell checking to prevent rendering differences
 			on('before:browser:launch', (browser, launchOptions) => {
 				if (browser.family === 'chromium' && browser.name !== 'electron') {
-					launchOptions.preferences.default['browser.enable_spellchecking'] = false
+					launchOptions.preferences.default[
+						'browser.enable_spellchecking'
+					] = false
 					return launchOptions
 				}
 
@@ -58,14 +63,14 @@ export default defineConfig({
 	},
 	component: {
 		devServer: {
-			framework: "vue",
-			bundler: "vite",
+			framework: 'vue',
+			bundler: 'vite',
 		},
 	},
 	retries: {
 		runMode: 2,
 		// do not retry in `cypress open`
 		openMode: 0,
 	},
-	'numTestsKeptInMemory': 5,
+	numTestsKeptInMemory: 5,
 })

cypress/.eslintrc.json

@@ -1,5 +1,3 @@
 {
-	"extends": [
-		"plugin:cypress/recommended"
-	]
+	"extends": ["plugin:cypress/recommended"]
 }

cypress/README.md

@@ -4,36 +4,37 @@
 -->
 
 # Cypress tests
+
 There are some custom cypress commands available making it easier to write tests,
 for example you can get the editor content and insert text by using
 
 ```js
-cy.getContent()
-    .type('some test')
+cy.getContent().type('some test')
 ```
 
 ### Available custom commands
-| Command              | Function               | Parameters                          |
-| -------------------- | ---------------------- | ----------------------------------- |
-| `uploadFile`         | Upload file            | `fileName`, `mimeType`, `target`    |
-| `createFile`         | Create file            | `target`, `content`, `mimeType`     |
-| `moveFile`           | Move a file            | `path`, `destinationPath`           |
-| `copyFile`           | Copy file              | `path`, `destinationPath`           |
-| `createFolder`       | Create a folder        | `dirName`                           |
-| `shareFileToUser`    | Share a file with user | `userId`, `password`, `path`, `targetUserId`|
-| `openFile`           | Open file in Viewer / Editor | `fileName`, `clickParams`     |
-| `closeFile`          | Close the current file |                                     |
-| `getFile`            | Get file list element of file | `fileName`                   |
-| `deleteFile`         | Remove a file          | `fileName`                          |
-| `reloadFileList`     | Refresh the file list  |                                     |
-| `getEditor`          | Get TipTap Editor element |                                  |
-| `getContent`         | Get editor content     |                                     |
-| `clearContent`       | Clear the editor content |                                   |
-| `getMenu`            | Get editor menu bar    |                                     |
-| `getMenuEntry`       | Same as `getActionEntry` but also searches the overflow menu | `name` |
-| `getSubmenuEntry`    | Open parent menu and then return sub menu entry | `parent`, `name` |
-| `getActionEntry`     | Get menu entry         | `name`                              |
-| `getActionSubEntry`  | Get submenu entry (after menu clicked) | `name`              |
-| `openWorkspace`      | Open workspace and return Editor content |                   |
+
+| Command             | Function                                                     | Parameters                                   |
+| ------------------- | ------------------------------------------------------------ | -------------------------------------------- |
+| `uploadFile`        | Upload file                                                  | `fileName`, `mimeType`, `target`             |
+| `createFile`        | Create file                                                  | `target`, `content`, `mimeType`              |
+| `moveFile`          | Move a file                                                  | `path`, `destinationPath`                    |
+| `copyFile`          | Copy file                                                    | `path`, `destinationPath`                    |
+| `createFolder`      | Create a folder                                              | `dirName`                                    |
+| `shareFileToUser`   | Share a file with user                                       | `userId`, `password`, `path`, `targetUserId` |
+| `openFile`          | Open file in Viewer / Editor                                 | `fileName`, `clickParams`                    |
+| `closeFile`         | Close the current file                                       |                                              |
+| `getFile`           | Get file list element of file                                | `fileName`                                   |
+| `deleteFile`        | Remove a file                                                | `fileName`                                   |
+| `reloadFileList`    | Refresh the file list                                        |                                              |
+| `getEditor`         | Get TipTap Editor element                                    |                                              |
+| `getContent`        | Get editor content                                           |                                              |
+| `clearContent`      | Clear the editor content                                     |                                              |
+| `getMenu`           | Get editor menu bar                                          |                                              |
+| `getMenuEntry`      | Same as `getActionEntry` but also searches the overflow menu | `name`                                       |
+| `getSubmenuEntry`   | Open parent menu and then return sub menu entry              | `parent`, `name`                             |
+| `getActionEntry`    | Get menu entry                                               | `name`                                       |
+| `getActionSubEntry` | Get submenu entry (after menu clicked)                       | `name`                                       |
+| `openWorkspace`     | Open workspace and return Editor content                     |                                              |
 
 We also use some commands from the [`@nextcloud/cypress`](https://github.com/nextcloud/nextcloud-cypress) package.

cypress/component/editor/search.cy.js

@@ -7,8 +7,8 @@ import { Editor } from '@tiptap/core'
 import { Document } from '@tiptap/extension-document'
 import { Text } from '@tiptap/extension-text'
 import Search from '../../../src/extensions/Search.js'
-import Paragraph from '../../../src/nodes/Paragraph.js'
 import HardBreak from '../../../src/nodes/HardBreak.js'
+import Paragraph from '../../../src/nodes/Paragraph.js'
 
 describe('editor search highlighting', () => {
 	let editor = null
@@ -27,7 +27,9 @@ describe('editor search highlighting', () => {
 		const searchQuery = 'Lorem ipsum dolor sit amet'
 		editor.commands.setSearchQuery(searchQuery)
 
-		const highlightedElements = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const highlightedElements = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 		expect(highlightedElements).to.have.lengthOf(1)
 		verifyHighlights(highlightedElements, searchQuery)
 	})
@@ -36,7 +38,9 @@ describe('editor search highlighting', () => {
 		const searchQuery = 'quod'
 		editor.commands.setSearchQuery(searchQuery)
 
-		const highlightedElements = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const highlightedElements = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 		expect(highlightedElements).to.have.lengthOf(3)
 		verifyHighlights(highlightedElements, searchQuery)
 	})
@@ -47,7 +51,9 @@ describe('editor search highlighting', () => {
 
 		// Highlight only first occurrence
 		editor.commands.setSearchQuery(searchQuery, false)
-		highlightedElements = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		highlightedElements = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 
 		expect(highlightedElements).to.have.lengthOf(1)
 		verifyHighlights(highlightedElements, searchQuery)
@@ -57,26 +63,38 @@ describe('editor search highlighting', () => {
 		const searchQuery = 'quod'
 
 		editor.commands.setSearchQuery(searchQuery, true)
-		const allHighlightedElements = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const allHighlightedElements = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 
 		editor.commands.nextMatch()
-		const currentlyHighlightedElement = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const currentlyHighlightedElement = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 
 		expect(currentlyHighlightedElement).to.have.lengthOf(1)
-		expect(allHighlightedElements[1]).to.deep.equal(currentlyHighlightedElement[0])
+		expect(allHighlightedElements[1]).to.deep.equal(
+			currentlyHighlightedElement[0],
+		)
 	})
 
 	it('can move to previous occurrence', () => {
 		const searchQuery = 'quod'
 
 		editor.commands.setSearchQuery(searchQuery, true)
-		const allHighlightedElements = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const allHighlightedElements = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 
 		editor.commands.previousMatch()
-		const currentlyHighlightedElement = document.querySelectorAll('span[data-text-el="search-decoration"]')
+		const currentlyHighlightedElement = document.querySelectorAll(
+			'span[data-text-el="search-decoration"]',
+		)
 
 		expect(currentlyHighlightedElement).to.have.lengthOf(1)
-		expect(allHighlightedElements[0]).to.deep.equal(currentlyHighlightedElement[0])
+		expect(allHighlightedElements[0]).to.deep.equal(
+			currentlyHighlightedElement[0],
+		)
 	})
 })