Skip to content

Commit 6ad9e62

Browse files
ifiokjrifiokjr
committed
Initial commit for template repository
0 parents  commit 6ad9e62

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+14747
-0
lines changed

‎.changeset/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with multi-package repos, or single-package repos to help you version and publish your code. You can find the full documentation for it [in our repository](https://github.com/changesets/changesets)
4+
5+
We have a quick list of common questions to get you started engaging with this project in [our documentation](https://github.com/changesets/changesets/blob/master/docs/common-questions.md)

‎.changeset/config.json

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"ignore": [
5+
"@remirror/e2e",
6+
"@remirror/storybook",
7+
"@remirror/support",
8+
"@remirror/testing",
9+
"@remirror/website",
10+
"with-next"
11+
],
12+
"updateInternalDependencies": "patch",
13+
"commit": false,
14+
"linked": [
15+
[
16+
"@remirror/cli",
17+
"@remirror/core-constants",
18+
"@remirror/core-helpers",
19+
"@remirror/core-types",
20+
"@remirror/core-utils",
21+
"@remirror/core",
22+
"@remirror/dev",
23+
"@remirror/dom",
24+
"@remirror/extension-annotation",
25+
"@remirror/extension-auto-link",
26+
"@remirror/extension-bidi",
27+
"@remirror/extension-blockquote",
28+
"@remirror/extension-bold",
29+
"@remirror/extension-code-block",
30+
"@remirror/extension-code",
31+
"@remirror/extension-collaboration",
32+
"@remirror/extension-diff",
33+
"@remirror/extension-doc",
34+
"@remirror/extension-drop-cursor",
35+
"@remirror/extension-emoji",
36+
"@remirror/extension-epic-mode",
37+
"@remirror/extension-events",
38+
"@remirror/extension-gap-cursor",
39+
"@remirror/extension-hard-break",
40+
"@remirror/extension-heading",
41+
"@remirror/extension-history",
42+
"@remirror/extension-horizontal-rule",
43+
"@remirror/extension-image",
44+
"@remirror/extension-italic",
45+
"@remirror/extension-link",
46+
"@remirror/extension-mention",
47+
"@remirror/extension-paragraph",
48+
"@remirror/extension-placeholder",
49+
"@remirror/extension-position-tracker",
50+
"@remirror/extension-positioner",
51+
"@remirror/extension-react-component",
52+
"@remirror/extension-react-ssr",
53+
"@remirror/extension-search",
54+
"@remirror/extension-strike",
55+
"@remirror/extension-text",
56+
"@remirror/extension-trailing-node",
57+
"@remirror/extension-underline",
58+
"@remirror/extension-yjs",
59+
"@remirror/i18n",
60+
"@remirror/playground",
61+
"@remirror/pm",
62+
"@remirror/preset-core",
63+
"@remirror/preset-embed",
64+
"@remirror/preset-list",
65+
"@remirror/preset-react-checkbox",
66+
"@remirror/preset-react",
67+
"@remirror/preset-social",
68+
"@remirror/preset-table",
69+
"@remirror/preset-wysiwyg",
70+
"@remirror/react-social",
71+
"@remirror/react-utils",
72+
"@remirror/react-wysiwyg",
73+
"@remirror/react",
74+
"@remirror/showcase",
75+
"@remirror/styles",
76+
"@remirror/theme",
77+
"a11y-status",
78+
"jest-prosemirror",
79+
"jest-remirror",
80+
"multishift",
81+
"prosemirror-suggest",
82+
"remirror",
83+
"test-keyboard"
84+
]
85+
],
86+
"access": "public",
87+
"baseBranch": "main"
88+
}

‎.devcontainer/Dockerfile

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.134.0/containers/javascript-node/.devcontainer/base.Dockerfile
2+
ARG VARIANT="14"
3+
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
4+
5+
# [Optional] Uncomment this section to install additional OS packages.
6+
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
7+
# && apt-get -y install --no-install-recommends <your-package-list-here>
8+
9+
# [Optional] Uncomment if you want to install an additional version of node using nvm
10+
# ARG EXTRA_NODE_VERSION=10
11+
# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
12+
13+
# [Optional] Uncomment if you want to install more global node modules
14+
RUN sudo -u node npm install -g pnpm

‎.devcontainer/devcontainer.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
2+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.134.0/containers/javascript-node
3+
{
4+
"name": "remirror",
5+
"build": {
6+
"dockerfile": "Dockerfile",
7+
// Update 'VARIANT' to pick a Node version: 10, 12, 14
8+
"args": { "VARIANT": "14" }
9+
},
10+
11+
// Set *default* container specific settings.json values on container create.
12+
"settings": {
13+
"terminal.integrated.shell.linux": "/bin/bash"
14+
},
15+
16+
// Add the IDs of extensions you want installed when the container is created.
17+
"extensions": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"],
18+
19+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
20+
"forwardPorts": [3000, 6006, 3030],
21+
22+
// Use 'postCreateCommand' to run commands after the container is created.
23+
"postCreateCommand": "pnpm install",
24+
25+
// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
26+
"remoteUser": "node"
27+
}

‎.gitattributes

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Generated files we don't want to see in code review/diff
2+
docs/generated/gatsby.ts binary
3+
4+
**/__image_snapshots__/*.* binary
5+
**/__image_snapshots__/*.* filter=lfs diff=lfs merge=lfs -text
6+
7+
*.png filter=lfs diff=lfs merge=lfs -text
8+
*.gif filter=lfs diff=lfs merge=lfs -text
9+
*.sketch filter=lfs diff=lfs merge=lfs -text
10+
*.jpeg filter=lfs diff=lfs merge=lfs -text
11+
*.jpg filter=lfs diff=lfs merge=lfs -text
12+
*.ico filter=lfs diff=lfs merge=lfs -text

‎.github/ISSUE_TEMPLATE/bug_report.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: 🐞 Report a bug
3+
about: Found something broken? Let us know! If it's not yet reproducible, please `Ask a question` instead.
4+
labels: 'type: bug :beetle:'
5+
---
6+
7+
### Summary
8+
9+
<!-- A brief summary of the problem. -->
10+
11+
### Steps to reproduce
12+
13+
<!-- All bug reports should include detailed steps to reproduce -->
14+
15+
### Expected results
16+
17+
<!-- Outline what you expected to see -->
18+
19+
### Actual results
20+
21+
<!-- Outline the actual results -->
22+
23+
### Additional context
24+
25+
<!-- Optionally provide additional context such as browser version / device etc... -->
26+
27+
### Possible Solution
28+
29+
<!--- Optionally suggest a fix or reason for the bug -->

‎.github/ISSUE_TEMPLATE/config.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
blank_issues_enabled: false
2+
3+
# Remove this file if you don't have **Discussions** enabled for your project.
4+
contact_links:
5+
- name: 💡 Discuss an idea
6+
url: https://github.com/remirror/template/discussions/new
7+
about:
8+
Suggest your ideas for this project. Discussions with high interest and positive feedback will
9+
be added to the roadmap.
10+
11+
- name: ❔ Ask a question
12+
url: https://github.com/remirror/template/discussions/new
13+
about: Ask questions and discuss with other community members.
14+
15+
- name: 🙏 Request help
16+
url: https://github.com/remirror/template/discussions/new
17+
about: Ask the `remirror` community for help.
18+
19+
- name: 🌟 Showcase your work
20+
url: https://github.com/remirror/template/discussions/new
21+
about: Showcase what you've been building with `remirror`.

‎.github/ISSUE_TEMPLATE/project-roadmap.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 📥 Add to the project roadmap
3+
about: 'Create an issue for concrete work to add to project roadmap. For ideas and questions, choose `Discuss an idea` or `Ask a question` instead.'
4+
---
5+
6+
### Description
7+
8+
<!--- Provide a detailed explanation of the issue and your reasons for creating it as well as any expected outcomes. -->
9+
10+
### Context
11+
12+
<!--- Provide more context as to why this is important. Any links to where it has previously been discussed or implemented will be appreciated. -->

‎.github/actions/pnpm/action.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 'pnpm installation'
2+
description: 'Install and audit dependencies for pnpm'
3+
inputs:
4+
cache: # id of input
5+
description: 'The location of the pnpm cache'
6+
required: true
7+
default: '.pnpm-store'
8+
version: # id of input
9+
description: 'The version to use'
10+
required: false
11+
default: 5.5.2
12+
13+
runs:
14+
using: 'composite'
15+
steps:
16+
- name: install pnpm
17+
run: npm install pnpm@${{ inputs.version }} -g
18+
shell: bash
19+
20+
- name: setup pnpm config
21+
run: pnpm config set store-dir ${{ inputs.cache }}
22+
shell: bash
23+
24+
- name: audit dependencies
25+
run: pnpm audit --audit-level high
26+
shell: bash
27+
28+
- name: install dependencies
29+
run: pnpm install
30+
shell: bash

‎.github/pull_request_template.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### Description
2+
3+
<!-- Describe your changes in detail and reference any issues it addresses-->
4+
5+
### Checklist
6+
7+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
8+
9+
- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/HEAD/docs/contributing.md) document.
10+
- [ ] My code follows the code style of this project and `pnpm fix` completed successfully.
11+
- [ ] I have updated the documentation where necessary.
12+
- [ ] New code is unit tested and all current tests pass when running `pnpm test`.
13+
14+
### Screenshots
15+
16+
<!-- Delete this section if not applicable -->

‎.github/readme.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<div align="center">
2+
<br />
3+
<div align="center">
4+
<img width="300" height="300" src="../support/assets/logo.svg" alt="svg logo" />
5+
</div>
6+
<br />
7+
<br />
8+
<br />
9+
<div align="center">
10+
<a href="https://github.com/remirror/template/actions?query=workflow:ci"><img src="https://github.com/remirror/template/workflows/ci/badge.svg?branch=next" alt="Continuous integration badge for github actions" /></a>
11+
</div>
12+
</div>
13+
14+
> Add your motivational tagline here.
15+
16+
<br />
17+
18+
## Setup
19+
20+
To setup this repo for your use:
21+
22+
- Find and replace `remirror/template` with `user/repo` across the whole project.
23+
- Add your first package in the packages folder.
24+
25+
To enable automated publishing add your npm token to to your repo secrets with the name `NPM_TOKEN`.
26+
27+
<br />
28+
29+
## Contributing
30+
31+
Please read our [contribution guide] for details on our code of conduct, and the process for submitting pull requests. It also outlines the project structure so you can find help when navigating your way around the codebase.
32+
33+
In addition each folder in this codebase a readme describing why it exists.
34+
35+
You might also notice there are surprisingly few files in the root directory of this project. All the configuration files have been moved to the `support/root` directory and are symlinked to the root directory in a `preinstall` hook. For more information take a look at [folder](support/root) and [readme](support/root/readme.md).
36+
37+
<br />
38+
39+
## Versioning
40+
41+
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/remirror/template/tags).
42+
43+
<br />
44+
45+
## License
46+
47+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
48+
49+
[contribution guide]: docs/contributing
50+
[typescript]: https://github.com/microsoft/Typescript

0 commit comments

Comments
 (0)