Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
lihbr committed Aug 16, 2023
0 parents commit 89e992e
Show file tree
Hide file tree
Showing 30 changed files with 8,178 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# editorconfig.org
root = true

[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_style = space
indent_size = 2
40 changes: 40 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# .gitignore copy

# custom
dist
examples/**/package-lock.json

# os
.DS_Store
._*

# node
logs
*.log
node_modules

# yarn
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.yarn-integrity
yarn.lock

# npm
npm-debug.log*

# tests
coverage
.eslintcache
.nyc_output

# .env
.env
.env.test
.env*.local

# vscode
.vscode/*
!.vscode/tasks.json
!.vscode/launch.json
*.code-workspace
38 changes: 38 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
module.exports = {
root: true,
env: {
browser: true,
node: true,
},
parserOptions: {
parser: "@typescript-eslint/parser",
ecmaVersion: 2020,
},
extends: [
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended",
],
plugins: ["eslint-plugin-tsdoc"],
rules: {
"no-console": ["warn", { allow: ["info", "warn", "error"] }],
"no-debugger": "warn",
"no-undef": "off",
curly: "error",
"prefer-const": "error",
"padding-line-between-statements": [
"error",
{ blankLine: "always", prev: "*", next: "return" },
],
"@typescript-eslint/no-unused-vars": [
"error",
{
argsIgnorePattern: "^_",
varsIgnorePattern: "^_",
},
],
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/explicit-module-boundary-types": "error",
"tsdoc/syntax": "warn",
},
};
13 changes: 13 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# asserts everything is text
* text eol=lf

# treats lock files as binaries to prevent merge headache
package-lock.json -diff
yarn.lock -diff

# treats assets as binaries
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.ico binary
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: 🚨 Bug report
about: Report a bug report to help improve the package.
title: ""
labels: "bug"
assignees: ""
---

<!-- 💙 Thanks for your time to make this package better with your feedback 💙
**IMPORTANT** Before reporting a bug please make sure that you have read through the documentation:
- https://prismic.io/docs
👍 A properly detailed bug report can save a LOT of time and help fixing issues as soon as possible.
-->

### Versions

- package_name: <!-- ex: v0.1.0 -->
- node: <!-- ex: v14.15.0 -->

### Reproduction

<!-- If possible link to a minimal test case. Without a reproduction, it is very difficult to address problems. :( -->

<details open>
<summary>Additional Details</summary>
<br>
<!-- Attaching `package.json`, dependencies, logs or code snippets would help to find the issue -->
</details>

### Steps to reproduce

### What is expected?

### What is actually happening?
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 👪 Prismic Community Forum
url: https://community.prismic.io
about: Ask a question about the package or raise an issue directly related to Prismic. You will usually get support there more quickly!
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: 🙋‍♀️ Feature request
about: Suggest an idea or enhancement for the package.
title: ""
labels: "enhancement"
assignees: ""
---

<!-- 💙 Thanks for your time to make this package better with your feedback 💙 -->

### Is your feature request related to a problem? Please describe.

<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

### Describe the solution you'd like

<!-- A clear and concise description of what you want to happen. Adding some code examples would be neat! -->

### Describe alternatives you've considered

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

### Additional context

<!-- Add any other context or screenshots about the feature request here. -->
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--- Provide a general summary of your changes in the title above -->

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Chore (a non-breaking change which is related to package maintenance)
- [ ] Bug fix (a non-breaking change which fixes an issue)
- [ ] New feature (a non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Description

<!--- Describe your changes in detail -->
<!--- Why is this change required? What problem does it solve? -->
<!--- If it resolves an open issue, please link to the issue here. For example "Resolves: #137" -->

## Checklist:

<!--- Put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My change requires an update to the official documentation.
- [ ] All [TSDoc](https://tsdoc.org) comments are up-to-date and new ones have been added where necessary.
- [ ] All new and existing tests are passing.

<!--- A cute animal (or car) picture is welcome to close your PR! -->
60 changes: 60 additions & 0 deletions .github/prismic-oss-ecosystem.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89e992e

Please sign in to comment.