@scm-manager/scm-code-editor-plugin 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +6 -1
  2. package/README.md +49 -39
  3. package/gradle/wrapper/gradle-wrapper.jar +0 -0
  4. package/package.json +60 -54
  5. package/src/main/js/components/EditorTheme.css +10 -15
package/CHANGELOG.md CHANGED
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
4
4
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
5
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
6
 
7
- ## [1.0.0] - 2020-10-27
7
+ ## 1.0.1 - 2022-01-07
8
+ ### Fixed
9
+ - High contrast mode findings ([#4](https://github.com/scm-manager/scm-code-editor-plugin/pull/4))
10
+
11
+ ## 1.0.0 - 2020-10-27
8
12
  ### Added
9
13
  - Provides code-editor which can be used by other plugins
14
+
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <a href="https://www.scm-manager.org/">
2
+ <a href="https://scm-manager.org/">
3
3
  <img alt="SCM-Manager" src="https://download.scm-manager.org/images/logo/scm-manager_logo.png" width="500" />
4
4
  </a>
5
5
  </p>
@@ -7,33 +7,37 @@
7
7
  scm-code-editor-plugin
8
8
  </h1>
9
9
 
10
- Provides a dedicated code editor component to be used by other plugins
10
+ The CodeEditor plugin provides a dedicated code editor component to be used by other plugins.
11
+
12
+ ## Usage
13
+
14
+ Find out how this plugin can be used on the [user documentation page](https://scm-manager.org/plugins/scm-code-editor-plugin/docs).
11
15
 
12
16
  ## Build and testing
13
17
 
14
- The plugin can be compiled and packaged with the normal maven lifecycle:
18
+ The plugin can be compiled and packaged with the following tasks:
15
19
 
16
- * clean - `mvn clean` - removes the target directory, can be combined with other phases
17
- * compile - `mvn compile` - compiles Java code and creates the ui bundle
18
- * test - `mvn test` - executes test for Java and JavaScript
19
- * install - `mvn install` - installs the plugin (smp and jar) in the local maven repository
20
- * package - `mvn package` - creates the final plugin bundle (smp package) in the target folder
21
- * deploy - `mvn deploy` - deploys the plugin (smp and jar) to the configured remote repository
20
+ * clean - `gradle clean` - deletes the build directory
21
+ * run - `gradle run` - starts an SCM-Manager with the plugin pre-installed and with livereload for the ui
22
+ * build - `gradle build` - executes all checks, tests and builds the smp inclusive javadoc and source jar
23
+ * test - `gradle test` - run all java tests
24
+ * ui-test - `gradle ui-test` - run all ui tests
25
+ * check - `gradle check` - executes all registered checks and tests (java and ui)
26
+ * fix - `gradle fix` - fixes all fixable findings of the check task
27
+ * smp - `gradle smp` - Builds the smp file, without the execution of checks and tests
22
28
 
23
- For the development and testing the `serve` lifecycle of the plugin can be used:
29
+ For the development and testing the `run` task of the plugin can be used:
24
30
 
25
- * run - `mvn run` - starts scm-manager with the plugin pre installed.
31
+ * run - `gradle run` - starts scm-manager with the plugin pre-installed.
26
32
 
27
- If the plugin was started with `mvn run`, the default browser of the os should be automatically opened.
33
+ If the plugin was started with `gradle run`, the default browser of the os should be automatically opened.
28
34
  If the browser does not start automatically, start it manually and go to [http://localhost:8081/scm](http://localhost:8081/scm).
29
35
 
30
- In this mode each change to web files (src/main/js or src/main/webapp), should trigger a reload of the browser with the made changes.
31
- If you compile a class (e.g.: with your IDE from src/main/java to target/classes),
32
- the SCM-Manager context will restart automatically. So you can see your changes without restarting the server.
36
+ In this mode each change to web files (src/main/js or src/main/webapp), should trigger reload of the browser with the made changes.
33
37
 
34
38
  ## Directory & File structure
35
39
 
36
- A quick look at the files and directories you'll see in a SCM-Manager project.
40
+ A quick look at the files and directories you'll see in an SCM-Manager project.
37
41
 
38
42
  .
39
43
  ├── node_modules/
@@ -42,55 +46,61 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
42
46
  | | ├── java/
43
47
  | | ├── js/
44
48
  | | └── resources/
45
- | ├── test/
46
- | | ├── java/
47
- | | └── resources/
48
- | └── target/
49
+ | └── test/
50
+ | ├── java/
51
+ | └── resources/
49
52
  ├── .editorconfig
50
53
  ├── .gitignore
54
+ ├── build.gradle
51
55
  ├── CHANGELOG.md
52
- ├── LICENSE
56
+ ├── gradle.properties
57
+ ├── gradlew
58
+ ├── LICENSE.txt
53
59
  ├── package.json
54
- ├── pom.xml
55
60
  ├── README.md
61
+ ├── settings.gradle
56
62
  ├── tsconfig.json
57
63
  └── yarn.lock
58
64
 
59
- 1. **`node_modules/`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
65
+ 1. **`node_modules/`**: This directory contains all modules of code that your project depends on (npm packages) are automatically installed.
60
66
 
61
- 2. **`src/`**: This directory will contain all of the code related to what you see or not. `src` is a convention for “source code”.
67
+ 2. **`src/`**: This directory will contain all code related to what you see or not. `src` is a convention for “source code”.
62
68
  1. **`main/`**
63
- 1. **`java/`**: This directory contain the Java code.
69
+ 1. **`java/`**: This directory contains the Java code.
64
70
  2. **`js/`**: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with `.test.ts`
65
- 3. **`resources/`**: This directory contains the the classpath resources.
71
+ 3. **`resources/`**: This directory contains the classpath resources.
66
72
  2. **`test/`**
67
73
  1. **`java/`**: This directory contains the Java unit tests.
68
- 3. **`resources/`**: This directory contains classpath resources for unit tests.
69
- 3. **`target/`**: This is the build directory.
70
-
74
+ 2. **`resources/`**: This directory contains classpath resources for unit tests.
75
+
71
76
  3. **`.editorconfig`**: This is a configuration file for your editor using [EditorConfig](https://editorconfig.org/). The file specifies a style that IDEs use for code.
72
77
 
73
78
  4. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
74
79
 
75
- 5. **`CHANGELOG.md`**: All notable changes to this project will be documented in this file.
80
+ 5. **`build.gradle`**: Gradle build configuration, which also includes things like metadata.
76
81
 
77
- 6. **`LICENSE`**: This project is licensed under the MIT license.
82
+ 6. **`CHANGELOG.md`**: All notable changes to this project will be documented in this file.
78
83
 
79
- 7. **`package.json`**: Here you can find the dependency/build configuration and dependencies for the frontend.
84
+ 7. **`gradle.properties`**: Defines the module version.
80
85
 
81
- 8. **`pom.xml`**: Maven configuration, which also includes things like metadata.
86
+ 8. **`gradlew`**: Bundled gradle wrapper if you don't have gradle installed.
82
87
 
83
- 9. **`README.md`**: This file, containing useful reference information about the project.
88
+ 9. **`LICENSE.txt`**: This project is licensed under the MIT license.
84
89
 
85
- 10. **`tsconfig.json`** This is the typescript configuration file.
90
+ 10. **`package.json`**: Here you can find the dependency/build configuration and dependencies for the frontend.
86
91
 
87
- 11. **`yarn.lock`**: This is the ui dependency configuration.
92
+ 11. **`README.md`**: This file, containing useful reference information about the project.
93
+
94
+ 12. **`settings.gradle`**: Gradle settings configuration.
95
+
96
+ 13. **`tsconfig.json`** This is the typescript configuration file.
97
+
98
+ 14. **`yarn.lock`**: This is the ui dependency configuration.
88
99
 
89
100
  ## Need help?
90
101
 
91
- Looking for more guidance? Full documentation lives on our [homepage](https://www.scm-manager.org/docs/) or the dedicated pages for our [plugins](https://www.scm-manager.org/plugins/). Do you have further ideas or need support?
102
+ Looking for more guidance? Full documentation lives on our [homepage](https://scm-manager.org/docs/) or the dedicated pages for our [plugins](https://scm-manager.org/plugins/). Do you have further ideas or need support?
92
103
 
93
- - **Community Support** - Contact the SCM-Manager support team for questions about SCM-Manager, to report bugs or to request features through the official channels. [Find more about this here](https://www.scm-manager.org/support/).
104
+ - **Community Support** - Contact the SCM-Manager support team for questions about SCM-Manager, to report bugs or to request features through the official channels. [Find more about this here](https://scm-manager.org/support/).
94
105
 
95
106
  - **Enterprise Support** - Do you require support with the integration of SCM-Manager into your processes, with the customization of the tool or simply a service level agreement (SLA)? **Contact our development partner Cloudogu! Their team is looking forward to discussing your individual requirements with you and will be more than happy to give you a quote.** [Request Enterprise Support](https://cloudogu.com/en/scm-manager-enterprise/).
96
-
package/package.json CHANGED
@@ -1,63 +1,69 @@
1
1
  {
2
- "name" : "@scm-manager/scm-code-editor-plugin",
3
- "private" : false,
4
- "version" : "1.0.0",
5
- "license" : "MIT",
6
- "main" : "./src/main/js/index.tsx",
7
- "scripts" : {
8
- "gen-languages" : "node scripts/gen-languages.js",
9
- "build" : "ui-scripts plugin",
10
- "watch" : "ui-scripts plugin-watch",
11
- "postinstall" : "ui-plugins postinstall",
12
- "deploy" : "ui-scripts plugin-publish"
2
+ "name": "@scm-manager/scm-code-editor-plugin",
3
+ "private": false,
4
+ "version": "1.0.1",
5
+ "license": "MIT",
6
+ "main": "./src/main/js/index.tsx",
7
+ "scripts": {
8
+ "gen-languages": "node scripts/gen-languages.js",
9
+ "build": "plugin-scripts build",
10
+ "watch": "plugin-scripts watch",
11
+ "postinstall": "plugin-scripts postinstall",
12
+ "deploy": "plugin-scripts publish"
13
13
  },
14
- "dependencies" : {
15
- "@scm-manager/ui-components" : "^2.8.0",
16
- "@scm-manager/ui-extensions" : "^2.8.0",
17
- "@scm-manager/ui-plugins" : "2.8.0",
18
- "classnames" : "^2.2.6",
19
- "query-string" : "^5.0.1",
20
- "react" : "^16.10.2",
21
- "react-ace" : "^9.1.4",
22
- "react-i18next" : "^10.13.1",
23
- "react-redux" : "^5.0.7",
24
- "react-router-dom" : "^5.1.2",
25
- "redux" : "^4.0.0",
26
- "styled-components" : "^5.1.0"
14
+ "dependencies": {
15
+ "@scm-manager/ui-components": "^2.26.0",
16
+ "@scm-manager/ui-extensions": "^2.26.0",
17
+ "@scm-manager/ui-plugins": "2.26.0",
18
+ "classnames": "^2.2.6",
19
+ "query-string": "^5.0.1",
20
+ "react": "^17.0.1",
21
+ "react-ace": "^9.1.4",
22
+ "react-i18next": "^10.13.1",
23
+ "react-redux": "^5.0.7",
24
+ "react-router-dom": "^5.1.2",
25
+ "redux": "^4.0.0",
26
+ "styled-components": "^5.1.0",
27
+ "react-hook-form": "^7.5.1"
27
28
  },
28
- "babel" : {
29
- "presets" : [ "@scm-manager/babel-preset" ]
29
+ "babel": {
30
+ "presets": [
31
+ "@scm-manager/babel-preset"
32
+ ]
30
33
  },
31
- "jest" : {
32
- "preset" : "@scm-manager/jest-preset"
34
+ "jest": {
35
+ "preset": "@scm-manager/jest-preset"
33
36
  },
34
- "prettier" : "@scm-manager/prettier-config",
35
- "eslintConfig" : {
36
- "extends" : "@scm-manager/eslint-config"
37
+ "prettier": "@scm-manager/prettier-config",
38
+ "eslintConfig": {
39
+ "extends": "@scm-manager/eslint-config"
37
40
  },
38
- "devDependencies" : {
39
- "@scm-manager/babel-preset" : "^2.8.0",
40
- "@scm-manager/eslint-config" : "^2.8.0",
41
- "@scm-manager/jest-preset" : "^2.8.0",
42
- "@scm-manager/prettier-config" : "^2.8.0",
43
- "@scm-manager/tsconfig" : "^2.8.0",
44
- "@scm-manager/ui-scripts" : "^2.8.0",
45
- "@scm-manager/ui-tests" : "^2.8.0",
46
- "@scm-manager/ui-types" : "^2.8.0",
47
- "@types/classnames" : "^2.2.9",
48
- "@types/enzyme" : "^3.10.3",
49
- "@types/fetch-mock" : "^7.3.1",
50
- "@types/i18next" : "^13.0.0",
51
- "@types/jest" : "^24.0.19",
52
- "@types/query-string" : "5",
53
- "@types/react" : "^16.9.9",
54
- "@types/react-redux" : "5.0.7",
55
- "@types/react-router-dom" : "^5.1.0",
56
- "@types/styled-components" : "^5.1.0",
57
- "jest" : "^24.9.0"
41
+ "devDependencies": {
42
+ "@scm-manager/babel-preset": "^2.12.0",
43
+ "@scm-manager/eslint-config": "^2.12.0",
44
+ "@scm-manager/jest-preset": "^2.12.7",
45
+ "@scm-manager/prettier-config": "^2.10.1",
46
+ "@scm-manager/tsconfig": "^2.12.0",
47
+ "@scm-manager/ui-scripts": "^2.26.0",
48
+ "@scm-manager/ui-tests": "^2.26.0",
49
+ "@scm-manager/ui-types": "^2.26.0",
50
+ "@types/classnames": "^2.2.9",
51
+ "@types/enzyme": "^3.10.3",
52
+ "@types/fetch-mock": "^7.3.1",
53
+ "@types/i18next": "^13.0.0",
54
+ "@types/jest": "^24.0.19",
55
+ "@types/query-string": "5",
56
+ "@types/react": "^17.0.1",
57
+ "@types/react-redux": "5.0.7",
58
+ "@types/react-router-dom": "^5.1.0",
59
+ "@types/styled-components": "^5.1.0",
60
+ "jest": "^24.9.0",
61
+ "@scm-manager/plugin-scripts": "1.0.1"
58
62
  },
59
- "publishConfig" : {
60
- "access" : "public"
63
+ "publishConfig": {
64
+ "access": "public"
61
65
  },
62
- "files" : [ "src/main/js" ]
66
+ "files": [
67
+ "src/main/js"
68
+ ]
63
69
  }
package/src/main/js/components/EditorTheme.css CHANGED
@@ -1,4 +1,4 @@
1
- /**
1
+ /*
2
2
  * MIT License
3
3
  *
4
4
  * Copyright (c) 2020-present Cloudogu GmbH and Contributors
@@ -35,52 +35,47 @@
35
35
  }
36
36
 
37
37
  .scm-manager .ace_marker-layer .ace_selection {
38
- background: #F5871F;
39
- color: white;
40
- }
41
-
42
- .scm-manager .ace_marker-layer .ace_active-line {
43
- background: #f5f5f5
38
+ background: var(--sh-selected-color);
44
39
  }
45
40
 
46
41
  .scm-manager .ace_meta,
47
42
  .scm-manager .ace_meta.ace_tag,
48
43
  .scm-manager .ace_comment {
49
- color: #9a9a9a;
44
+ color: var(--sh-comment-color);
50
45
  }
51
46
 
52
47
  .scm-manager .ace_constant.ace_character,
53
48
  .scm-manager .ace_entity.ace_other.ace_attribute-name,
54
49
  .scm-manager .ace_string {
55
- color: #005f9a;
50
+ color: var(--sh-selector-color);
56
51
  }
57
52
 
58
53
  .scm-manager .ace_keyword.ace_operator {
59
- color: #686868;
54
+ color: var(--sh-operator-color);
60
55
  }
61
56
 
62
57
  .scm-manager .ace_variable,
63
58
  .scm-manager .ace_keyword {
64
- color: #00a984;
59
+ color: var(--sh-keyword-color);
65
60
  }
66
61
 
67
62
  .scm-manager .ace_entity.ace_name.ace_function,
68
63
  .scm-manager .ace_support.ace_function {
69
- color: #ff3860;
64
+ color: var(--sh-function-color);
70
65
  }
71
66
 
72
67
  .scm-manager .ace_variable,
73
68
  .scm-manager .ace_string.ace_regexp {
74
- color: #a74eb2;
69
+ color: var(--sh-variable-color);
75
70
  }
76
71
 
77
72
  .scm-manager .ace_constant.ace_other,
78
73
  .scm-manager .ace_invalid.ace_deprecated, /* ? */
79
74
  .scm-manager .ace_entity.ace_name.ace_tag,
80
75
  .scm-manager .ace_constant.ace_numeric {
81
- color: #2c99c7;
76
+ color: var(--sh-property-color);
82
77
  }
83
78
 
84
79
  .scm-manager .ace_constant.ace_language {
85
- color: #ff3860; /* or #363636 ? */
80
+ color: var(--sh-function-color);
86
81
  }