Skip to content

Commit

Permalink
feat: finish repo
Browse files Browse the repository at this point in the history
  • Loading branch information
littensy committed Jun 20, 2024
1 parent 7358f4a commit 05426c7
Show file tree
Hide file tree
Showing 14 changed files with 2,222 additions and 58 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: CI

on:
push:
branches: [main]
tags-ignore: [v*]
pull_request:
branches: [main]

jobs:
ci:
name: CI
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v4

- name: Install dependencies
run: pnpm install

- name: Lint files
run: pnpm lint

- name: Package extension
uses: haaleo/publish-vscode-extension@v1
with:
pat: _
dependencies: false
dryRun: true
47 changes: 47 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Publish

on:
release:
types: [published]

permissions:
contents: write

jobs:
publish:
name: Publish
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v4

- name: Install dependencies
run: pnpm install

- name: Lint files
run: pnpm lint

- name: Package extension
uses: haaleo/publish-vscode-extension@v1
id: package
with:
pat: _
dependencies: false
dryRun: true

- uses: abutler/[email protected]
with:
files: ${{ steps.package.outputs.vsixPath }}
repo-token: ${{ secrets.GITHUB_TOKEN }}

- name: Publish to Visual Studio Marketplace
uses: haaleo/publish-vscode-extension@v1
with:
pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}
extensionFile: ${{ steps.package.outputs.vsixPath }}
registryUrl: https://marketplace.visualstudio.com
dependencies: false
24 changes: 9 additions & 15 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
// A launch configuration that launches the extension inside a new window
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
{
"version": "0.2.0",
"configurations": [
{
"name": "Extension",
"type": "extensionHost",
"request": "launch",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}"
]
}
]
}
"configurations": [
{
"name": "Extension",
"type": "extensionHost",
"request": "launch",
"args": ["--extensionDevelopmentPath=${workspaceFolder}"]
}
]
}
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024 Littensy

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
56 changes: 46 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,52 @@
# charmed-icons README
<p align="center">
<p align="center">
<img src="assets/icon.png" alt="Logo" width="128" />
</p>
<h1 align="center"><b>Charmed Icons</b></h1>
<p align="center">
A charming set of icons for your Roblox projects.
<br />
<a href="https://marketplace.visualstudio.com/items?itemName=littensy.charmed-icons"><strong>Marketplace →</strong></a>
</p>
</p>

## Working with Markdown
<div align="center">

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
[![GitHub License](https://img.shields.io/github/license/littensy/charmed-icons?style=for-the-badge)](LICENSE.md)
![GitHub Stars](https://img.shields.io/github/stars/littensy/charmed-icons?style=for-the-badge&logo=github)

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
<img src="assets/files.png" alt="Files" width="512" />
<img src="assets/folders.png" alt="Folders" width="512" />

## For more information
</div>

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
## ⚙️ Usage

**Enjoy!**
### Marketplace

You can find my icons on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=littensy.charmed-icons).

### Manual

1. Download the `.vsix` file from the [Releases](https://github.com/littensy/charmed-icons/releases) page.
2. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) in VS Code.
3. Run the `Extensions: Install from VSIX...` command.

## ❤️ Gratitude

Charmed Icons draws inspiration from:

- [Catppuccin Icons](https://github.com/catppuccin/vscode-icons): Soothing pastel icons for VSCode.
- [Monospace Theme](https://github.com/keksiqc/monospace-theme): The Monospace Theme from Google's IDX.

---

<p align="center">
Charmed Icons is released under the <a href="LICENSE.md">MIT License</a>.
</p>

<div align="center">

[![MIT License](https://img.shields.io/github/license/littensy/charmed-icons?style=for-the-badge)](LICENSE.md)

</div>
Binary file added assets/files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/folders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import js from "@eslint/js";
import json from "eslint-plugin-json";

export default [
js.configs.recommended,
{
files: ["**/*.json"],
plugins: { json },
processor: "json/json",
"rules": {
"json/*": ["error", {"allowComments": true}],
},
},
];
19 changes: 18 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
{
"name": "charmed-icons",
"displayName": "Charmed Icons",
"description": "A charming icon set for Roblox codebases",
"description": "💝 Charming icon set for Roblox codebases",
"version": "0.1.0",
"publisher": "littensy",
"icon": "assets/icon.png",
"license": "MIT",
"type": "module",
"repository": {
"type": "git",
"url": "https://github.com/littensy/charmed-icons"
},
"engines": {
"vscode": "^1.88.0"
},
Expand All @@ -17,5 +25,14 @@
"path": "./themes/charmed-icon-theme.json"
}
]
},
"scripts": {
"lint": "eslint ."
},
"devDependencies": {
"@eslint/js": "^9.5.0",
"@vscode/vsce": "^2.28.0",
"eslint": "^9.5.0",
"eslint-plugin-json": "^4.0.0"
}
}
Loading

0 comments on commit 05426c7

Please sign in to comment.