Skip to content

Commit

Permalink
init :)
Browse files Browse the repository at this point in the history
  • Loading branch information
adamperkowski committed Feb 1, 2025
0 parents commit 9d0a93a
Show file tree
Hide file tree
Showing 5 changed files with 157 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/typos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Check for typos

on:
push:
branches: ["main"]
pull_request:
workflow_dispatch:

jobs:
check-typos:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Run spellcheck
uses: crate-ci/typos@v1.25.0
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2025, Adam Perkowski
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Jule for Emacs
Official [Jule](https://github.com/julelang/jule) mode for Emacs.

___

- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Code formatting](#code-formatting)
- [Development](#development)
- [Requirements](#requirements)
- [Setup](#setup)
- [Execution](#execution)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

___

## Features
- Syntax highlighting
- Code formatting ([julefmt](https://github.com/julelang/julefmt))

## Installation
The package is available on [MELPA](https://melpa.org) and can be installed with:
```elisp
(setq package-archives '(("melpa" . "https://melpa.org/packages/")))
(package-initialize)
(package-refresh-contents)
```
<kbd>M-x</kbd> `package-install` <kbd>RET</kbd> `jule-mode` <kbd>RET</kbd>

## Configuration
### Code formatting

## Development
### Requirements

### Setup

### Execution

## Code of Conduct
See the [Julenour Code of Conduct](https://jule.dev/code-of-conduct)

## License
The extension is distributed under the terms of the BSD 3-Clause license. <br>
[See License Details](/LICENSE)
2 changes: 2 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[files]
extend-exclude = ["CHANGELOG.md"]
62 changes: 62 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# https://git-cliff.org/docs/configuration

[changelog]
header = """
# Changelog\n
All notable changes to jule-mode will be documented in this file.\n
"""
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [upstream]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message }} ([{{ commit.id | truncate(length=7, end="") }}](<REPO>/commit/{{ commit.id }}))\
{% endfor %}
{% endfor %}\n
"""
footer = """
<sub>generated by [git-cliff](https://github.com/orhun/git-cliff) :)</sub>
"""
trim = true
postprocessors = [
{ pattern = '<REPO>', replace = "https://github.com/julelang/jule-mode.el" },
]
[git]
conventional_commits = true
filter_unconventional = false
split_commits = false
commit_preprocessors = [
# Replace issue numbers
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
{ pattern = '\n.*', replace = "" }
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^ui|^ux", group = "<!-- 5 -->🧩 UI/UX" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refact", group = "<!-- 2 -->🛠️ Refactoring" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "changelog", skip = true },
{ message = "^chore", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
{ body = ".*", group = "Other (unconventional)" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = true
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"

0 comments on commit 9d0a93a

Please sign in to comment.