Skip to content

Commit

Permalink
Project cleanup (#16)
Browse files Browse the repository at this point in the history
* Update release.yml

* Rename release.yml to pr-or-publish.yml

* Update and rename build.yml to previews.yml

* Delete .github/renovate.json

* Update README.md

* Create ISSUE_TEMPLATE

* Delete .github/ISSUE_TEMPLATE

* Create bug-report-twoslash.md

* Create new-plugin-idea.md

* Update and rename new-plugin-idea.md to new-plugin-idea.yml

* Update new-plugin-idea.yml

* Update new-plugin-idea.yml

* Create PULL_REQUEST_TEMPLATE.md

* Update package.json
  • Loading branch information
Adammatthiesen authored Nov 13, 2024
1 parent 6ec0a96 commit 362e72c
Show file tree
Hide file tree
Showing 8 changed files with 98 additions and 25 deletions.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report-twoslash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Bug report (expressive-code-twoslash)
about: Create a report to help us improve expressive-code-twoslash
title: '(Twoslash) Bug: [NAME]'
labels:
- bug
- twoslash
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/new-plugin-idea.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: New Plugin Idea
description: Suggest an idea for this repo
title: 'Plugin Request: [NAME]'
labels: idea
body:
- type: markdown
attributes:
value: |
Thanks for proposing a new idea for our repo!
- type: textarea
id: idea
attributes:
label: Describe your idea
description: Try to give as much detail as possible.
placeholder: Tell us what you want!
validations:
required: true
- type: textarea
id: examples
attributes:
label: Other examples?
description: Has there been something similar made for other highlighters such as Shiki?
placeholder: If not just respond no
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the plugin request here.
validations:
required: false
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Thank you for opening a PR! We really appreciate you taking the time to help out 🙌 -->

#### Description

- Closes # <!-- If aplicable add an issue number to this PR so it can be closed otherwise feel free to remove this. -->
- What does this PR change? Give us a brief description.

<!--
Here’s what will happen next:
One of our maintainers will review your pull request as soon as possible. We strive to provide feedback within a day, but please understand that responses may occasionally take longer depending on the circumstance and our availability. If we request any changes, please feel free to ask for clarification or provide additional context. We appreciate your patience and contribution to the project.
-->
19 changes: 0 additions & 19 deletions .github/renovate.json

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release
name: Create PR or Publish packages

on:
push:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI - Build & Preview
name: Preview Packages - pkg.pr.new

on: [pull_request]

Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# EC Plugins
# Expressive-Code Plugins By MatthiesenXYZ
[![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev/)

Collection of useful Community EC Plugins maintained by MatthiesenXYZ
Collection of useful Community Expressive-Code Plugins maintained by MatthiesenXYZ

- [expressive-code-twoslash](./packages/twoslash/) An Expressive Code plugin to add TwoSlash support
## Packages

### [`expressive-code-twoslash`](./packages/twoslash/) [![NPM Version](https://img.shields.io/npm/v/expressive-code-twoslash)](https://npm.im/expressive-code-twoslash)

An Expressive-Code plugin to add Twoslash support to your Expressive Code TypeScript code blocks.

![twoslash enabled codeblock](https://github.com/user-attachments/assets/d245d71e-158f-41a5-9df2-00c129a09f89)

Read more on the [`expressive-code-twoslash` Docs](https://twoslash.matthiesen.dev)

## Licensing

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"packageManager": "[email protected]",
"engines": {
"node": "20.14.0"
"node": ">=20.14.0"
},
"scripts": {
"playground:dev": "pnpm --filter playground dev",
Expand Down

0 comments on commit 362e72c

Please sign in to comment.