ep_special_characters 0.0.17 → 0.0.20

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.
package/.eslintrc.cjs ADDED
@@ -0,0 +1,9 @@
1
+ 'use strict';
2
+
3
+ // This is a workaround for https://github.com/eslint/eslint/issues/3458
4
+ require('eslint-config-etherpad/patch/modern-module-resolution');
5
+
6
+ module.exports = {
7
+ root: true,
8
+ extends: 'etherpad/plugin',
9
+ };
@@ -0,0 +1,11 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "github-actions"
4
+ directory: "/"
5
+ schedule:
6
+ interval: "daily"
7
+ - package-ecosystem: "npm"
8
+ directory: "/"
9
+ schedule:
10
+ interval: "daily"
11
+ versioning-strategy: "increase"
@@ -1,6 +1,3 @@
1
- # You need to change lines 38 and 46 in case the plugin's name on npmjs.com is different
2
- # from the repository name
3
-
4
1
  name: "Backend tests"
5
2
 
6
3
  # any branch is useful for testing before a PR is submitted
@@ -11,40 +8,68 @@ jobs:
11
8
  # run on pushes to any branch
12
9
  # run on PRs from external forks
13
10
  if: |
14
- (github.event_name != 'pull_request')
15
- || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
11
+ (github.event_name != 'pull_request')
12
+ || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
16
13
  name: with Plugins
17
14
  runs-on: ubuntu-latest
18
15
 
19
16
  steps:
20
- - name: Install libreoffice
21
- run: |
22
- sudo add-apt-repository -y ppa:libreoffice/ppa
23
- sudo apt update
24
- sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
25
-
26
- # clone etherpad-lite
27
- - name: Install etherpad core
28
- uses: actions/checkout@v2
29
- with:
30
- repository: ether/etherpad-lite
31
-
32
- - name: Install all dependencies and symlink for ep_etherpad-lite
33
- run: src/bin/installDeps.sh
34
-
35
- # clone this repository into node_modules/ep_plugin-name
36
- - name: Checkout plugin repository
37
- uses: actions/checkout@v2
38
- with:
39
- path: ./node_modules/${{github.event.repository.name}}
40
-
41
- - name: Install plugin dependencies
42
- run: |
43
- cd node_modules/${{github.event.repository.name}}
44
- npm ci
45
-
46
- - name: Run the backend tests
47
- run: cd src && npm test
48
-
49
- ##ETHERPAD_NPM_V=2
50
- ## NPM configuration automatically created using src/bin/plugins/updateAllPluginsScript.sh
17
+ -
18
+ name: Install libreoffice
19
+ run: |
20
+ sudo add-apt-repository -y ppa:libreoffice/ppa
21
+ sudo apt update
22
+ sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
23
+ -
24
+ name: Install etherpad core
25
+ uses: actions/checkout@v2
26
+ with:
27
+ repository: ether/etherpad-lite
28
+ -
29
+ name: Checkout plugin repository
30
+ uses: actions/checkout@v2
31
+ with:
32
+ path: ./node_modules/__tmp
33
+ -
34
+ name: Determine plugin name
35
+ id: plugin_name
36
+ run: |
37
+ cd ./node_modules/__tmp
38
+ npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
39
+ -
40
+ name: Rename plugin directory
41
+ run: |
42
+ mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
43
+ env:
44
+ PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
45
+ -
46
+ uses: actions/setup-node@v3
47
+ with:
48
+ node-version: 12
49
+ cache: 'npm'
50
+ cache-dependency-path: |
51
+ src/package-lock.json
52
+ src/bin/doc/package-lock.json
53
+ node_modules/${{ steps.plugin_name.outputs.plugin_name }}/package-lock.json
54
+ -
55
+ name: Install plugin dependencies
56
+ run: |
57
+ cd ./node_modules/"${PLUGIN_NAME}"
58
+ npm ci
59
+ env:
60
+ PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
61
+ # Etherpad core dependencies must be installed after installing the
62
+ # plugin's dependencies, otherwise npm will try to hoist common
63
+ # dependencies by removing them from src/node_modules and installing them
64
+ # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
65
+ # to be buggy, because it sometimes removes dependencies from
66
+ # src/node_modules but fails to add them to the top-level node_modules.
67
+ # Even if npm correctly hoists the dependencies, the hoisting seems to
68
+ # confuse tools such as `npm outdated`, `npm update`, and some ESLint
69
+ # rules.
70
+ -
71
+ name: Install Etherpad core dependencies
72
+ run: src/bin/installDeps.sh
73
+ -
74
+ name: Run the backend tests
75
+ run: cd src && npm test
@@ -0,0 +1,110 @@
1
+ # Publicly credit Sauce Labs because they generously support open source
2
+ # projects.
3
+ name: "frontend tests powered by Sauce Labs"
4
+
5
+ on: [push]
6
+
7
+ jobs:
8
+ test:
9
+ runs-on: ubuntu-latest
10
+
11
+ steps:
12
+ -
13
+ name: Fail if Dependabot
14
+ if: github.actor == 'dependabot[bot]'
15
+ run: |
16
+ cat <<EOF >&2
17
+ Frontend tests skipped because Dependabot can't access secrets.
18
+ Manually re-run the jobs to run the frontend tests.
19
+ For more information, see:
20
+ https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
21
+ EOF
22
+ exit 1
23
+ -
24
+ name: Generate Sauce Labs strings
25
+ id: sauce_strings
26
+ run: |
27
+ printf %s\\n '::set-output name=name::${{github.event.repository.name}} ${{ github.workflow }} - ${{ github.job }}'
28
+ printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}'
29
+ -
30
+ name: Check out Etherpad core
31
+ uses: actions/checkout@v2
32
+ with:
33
+ repository: ether/etherpad-lite
34
+ -
35
+ uses: actions/setup-node@v3
36
+ with:
37
+ node-version: 12
38
+ cache: 'npm'
39
+ cache-dependency-path: |
40
+ src/package-lock.json
41
+ src/bin/doc/package-lock.json
42
+ -
43
+ name: Check out the plugin
44
+ uses: actions/checkout@v2
45
+ with:
46
+ path: ./node_modules/__tmp
47
+ -
48
+ name: export GIT_HASH to env
49
+ id: environment
50
+ run: |
51
+ cd ./node_modules/__tmp
52
+ echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
53
+ -
54
+ name: Determine plugin name
55
+ id: plugin_name
56
+ run: |
57
+ cd ./node_modules/__tmp
58
+ npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
59
+ -
60
+ name: Rename plugin directory
61
+ env:
62
+ PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
63
+ run: |
64
+ mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
65
+ -
66
+ name: Install plugin dependencies
67
+ env:
68
+ PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
69
+ run: |
70
+ cd ./node_modules/"${PLUGIN_NAME}"
71
+ npm ci
72
+ # Etherpad core dependencies must be installed after installing the
73
+ # plugin's dependencies, otherwise npm will try to hoist common
74
+ # dependencies by removing them from src/node_modules and installing them
75
+ # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
76
+ # to be buggy, because it sometimes removes dependencies from
77
+ # src/node_modules but fails to add them to the top-level node_modules.
78
+ # Even if npm correctly hoists the dependencies, the hoisting seems to
79
+ # confuse tools such as `npm outdated`, `npm update`, and some ESLint
80
+ # rules.
81
+ -
82
+ name: Install Etherpad core dependencies
83
+ run: src/bin/installDeps.sh
84
+ -
85
+ name: Create settings.json
86
+ run: cp settings.json.template settings.json
87
+ -
88
+ name: Disable import/export rate limiting
89
+ run: |
90
+ sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 0/' -i settings.json
91
+ -
92
+ name: Remove standard frontend test files
93
+ run: rm -rf src/tests/frontend/specs
94
+ -
95
+ uses: saucelabs/sauce-connect-action@v2.1.1
96
+ with:
97
+ username: ${{ secrets.SAUCE_USERNAME }}
98
+ accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
99
+ tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
100
+ -
101
+ name: Run the frontend tests
102
+ shell: bash
103
+ env:
104
+ SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
105
+ SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
106
+ SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
107
+ TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
108
+ GIT_HASH: ${{ steps.environment.outputs.sha_short }}
109
+ run: |
110
+ src/tests/frontend/travis/runner.sh
@@ -21,50 +21,86 @@ jobs:
21
21
  # cloned to etherpad-lite then moved to ../etherpad-lite. To avoid
22
22
  # conflicts with this plugin's clone, etherpad-lite must be cloned and
23
23
  # moved out before this plugin's repo is cloned to $GITHUB_WORKSPACE.
24
- - uses: actions/checkout@v2
24
+ -
25
+ uses: actions/checkout@v2
25
26
  with:
26
27
  repository: ether/etherpad-lite
27
28
  path: etherpad-lite
28
- - run: mv etherpad-lite ..
29
+ -
30
+ run: mv etherpad-lite ..
29
31
  # etherpad-lite has been moved outside of $GITHUB_WORKSPACE, so it is now
30
32
  # safe to clone this plugin's repo to $GITHUB_WORKSPACE.
31
- - uses: actions/checkout@v2
32
- - uses: actions/setup-node@v1
33
+ -
34
+ uses: actions/checkout@v2
35
+ # This is necessary for actions/setup-node because '..' can't be used in
36
+ # cache-dependency-path.
37
+ -
38
+ name: Create ep_etherpad-lite symlink
39
+ run: |
40
+ mkdir -p node_modules
41
+ ln -s ../../etherpad-lite/src node_modules/ep_etherpad-lite
42
+ -
43
+ uses: actions/setup-node@v3
33
44
  with:
34
45
  node-version: 12
46
+ cache: 'npm'
47
+ cache-dependency-path: |
48
+ node_modules/ep_etherpad-lite/package-lock.json
49
+ node_modules/ep_etherpad-lite/bin/doc/package-lock.json
50
+ package-lock.json
35
51
  # All of ep_etherpad-lite's devDependencies are installed because the
36
52
  # plugin might do `require('ep_etherpad-lite/node_modules/${devDep}')`.
37
53
  # Eventually it would be nice to create an ESLint plugin that prohibits
38
54
  # Etherpad plugins from piggybacking off of ep_etherpad-lite's
39
55
  # devDependencies. If we had that, we could change this line to only
40
56
  # install production dependencies.
41
- - run: cd ../etherpad-lite/src && npm ci
42
- - run: npm ci
57
+ -
58
+ run: cd ../etherpad-lite/src && npm ci
59
+ -
60
+ run: npm ci
43
61
  # This runs some sanity checks and creates a symlink at
44
62
  # node_modules/ep_etherpad-lite that points to ../../etherpad-lite/src.
45
63
  # This step must be done after `npm ci` installs the plugin's dependencies
46
64
  # because npm "helpfully" cleans up such symlinks. :( Installing
47
65
  # ep_etherpad-lite in the plugin's node_modules prevents lint errors and
48
66
  # unit test failures if the plugin does `require('ep_etherpad-lite/foo')`.
49
- - run: npm install --no-save ep_etherpad-lite@file:../etherpad-lite/src
50
- - run: npm test
51
- - run: npm run lint
67
+ -
68
+ run: npm install --no-save ep_etherpad-lite@file:../etherpad-lite/src
69
+ -
70
+ run: npm test
71
+ -
72
+ run: npm run lint
52
73
 
53
74
  publish-npm:
54
75
  if: github.event_name == 'push'
55
76
  needs: test
56
77
  runs-on: ubuntu-latest
57
78
  steps:
58
- - uses: actions/checkout@v2
59
- - uses: actions/setup-node@v1
79
+ -
80
+ uses: actions/checkout@v2
81
+ with:
82
+ fetch-depth: 0
83
+ -
84
+ uses: actions/setup-node@v3
60
85
  with:
61
86
  node-version: 12
62
87
  registry-url: https://registry.npmjs.org/
63
- - run: git config user.name 'github-actions[bot]'
64
- - run: git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
65
- - run: npm ci
66
- - run: npm version patch
67
- - run: git push --follow-tags
88
+ cache: 'npm'
89
+ -
90
+ name: Bump version (patch)
91
+ run: |
92
+ LATEST_TAG=$(git describe --tags --abbrev=0) || exit 1
93
+ NEW_COMMITS=$(git rev-list --count "${LATEST_TAG}"..) || exit 1
94
+ [ "${NEW_COMMITS}" -gt 0 ] || exit 0
95
+ git config user.name 'github-actions[bot]'
96
+ git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
97
+ npm ci
98
+ npm version patch
99
+ git push --follow-tags
100
+ # This is required if the package has a prepare script that uses something
101
+ # in dependencies or devDependencies.
102
+ -
103
+ run: npm ci
68
104
  # `npm publish` must come after `git push` otherwise there is a race
69
105
  # condition: If two PRs are merged back-to-back then master/main will be
70
106
  # updated with the commits from the second PR before the first PR's
@@ -75,9 +111,12 @@ jobs:
75
111
  # already-used version number. By running `npm publish` after `git push`,
76
112
  # back-to-back merges will cause the first merge's workflow to fail but
77
113
  # the second's will succeed.
78
- - run: npm publish
114
+ -
115
+ run: npm publish
116
+ env:
117
+ NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
118
+ -
119
+ name: Add package to etherpad organization
120
+ run: npm access grant read-write etherpad:developers
79
121
  env:
80
122
  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
81
-
82
- ##ETHERPAD_NPM_V=2
83
- ## NPM configuration automatically created using bin/plugins/updateAllPluginsScript.sh
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,44 @@
1
+ ![Publish Status](https://github.com/ether/ep_special_characters/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/ep_special_characters/workflows/Backend%20tests/badge.svg)
2
+
3
+ # ep_special_characters
4
+
5
+ TODO: Describe the plugin.
6
+
7
+ ## Installation
8
+
9
+ From the Etherpad working directory, run:
10
+
11
+ ```shell
12
+ npm install --no-save --legacy-peer-deps ep_special_characters
13
+ ```
14
+
15
+ Or, install from Etherpad's `/admin/plugins` page.
16
+
17
+ ## Configuration
18
+
19
+ TODO
20
+
21
+ ## Testing
22
+
23
+ To run the backend tests, run the following from the Etherpad working directory:
24
+
25
+ ```shell
26
+ (cd src && npm test)
27
+ ```
28
+
29
+ To run the frontend tests, visit: http://localhost:9001/tests/frontend/
30
+
31
+ ## Copyright and License
32
+
33
+ Copyright © the ep_special_characters authors and contributors
34
+
35
+ Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"); you
36
+ may not use this file except in compliance with the License. You may obtain a
37
+ copy of the License at
38
+
39
+ http://www.apache.org/licenses/LICENSE-2.0
40
+
41
+ Unless required by applicable law or agreed to in writing, software distributed
42
+ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
43
+ CONDITIONS OF ANY KIND, either express or implied. See the License for the
44
+ specific language governing permissions and limitations under the License.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "ep_special_characters",
3
3
  "description": "Insert special characters into a pad",
4
- "version": "0.0.17",
4
+ "version": "0.0.20",
5
5
  "author": {
6
6
  "name": "Johnyma22",
7
7
  "email": "john@mclear.co.uk",
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "dependencies": {},
11
11
  "engines": {
12
- "node": ">=10.17.0"
12
+ "node": ">=12.17.0"
13
13
  },
14
14
  "repository": {
15
15
  "repository": {
@@ -19,21 +19,12 @@
19
19
  },
20
20
  "funding": {
21
21
  "type": "individual",
22
- "url": "http://etherpad.org/"
22
+ "url": "https://etherpad.org/"
23
23
  },
24
24
  "devDependencies": {
25
- "eslint": "^7.18.0",
26
- "eslint-config-etherpad": "^1.0.24",
27
- "eslint-plugin-eslint-comments": "^3.2.0",
28
- "eslint-plugin-mocha": "^8.0.0",
29
- "eslint-plugin-node": "^11.1.0",
30
- "eslint-plugin-prefer-arrow": "^1.2.3",
31
- "eslint-plugin-promise": "^4.2.1",
32
- "eslint-plugin-you-dont-need-lodash-underscore": "^6.10.0"
33
- },
34
- "eslintConfig": {
35
- "root": true,
36
- "extends": "etherpad/plugin"
25
+ "eslint": "^8.9.0",
26
+ "eslint-config-etherpad": "^3.0.1",
27
+ "typescript": "^4.5.5"
37
28
  },
38
29
  "scripts": {
39
30
  "lint": "eslint .",
package/LICENSE.md DELETED
@@ -1,14 +0,0 @@
1
- Copyright 2020 John McLear
2
-
3
-
4
- Licensed under the Apache License, Version 2.0 (the "License");
5
- you may not use this file except in compliance with the License.
6
- You may obtain a copy of the License at
7
-
8
- http://www.apache.org/licenses/LICENSE-2.0
9
-
10
- Unless required by applicable law or agreed to in writing, software
11
- distributed under the License is distributed on an "AS IS" BASIS,
12
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- See the License for the specific language governing permissions and
14
- limitations under the License.