Merge branch 'release/0.1.0'

Author: devsheva

.tool-versions

@@ -1 +1 @@
-nodejs 22.6.0
+nodejs 22.7.0

CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2024-09-03
+
+### 🚀 Features
+
+- *(vitest)* Setup spec folder
+- *(ci)* Add test and coverage workflows
+- *(logger)* Add base class with logger property
+- *(logger)* Add name and level property
+- *(logger)* Add log method for all levels
+- Add changelog with git-cliff
+
+### 🐛 Bug Fixes
+
+- [**breaking**] Remove base class since it was causing runtime error
+
+### 🚜 Refactor
+
+- *(logger)* Switch to enum to have a numeric comparison when checking log level
+
+### 📚 Documentation
+
+- Use shields.io for badges
+- Add instructions on how to temporary type a property added by a decorator
+
+### 🧪 Testing
+
+- *(logger)* Ensure name is set when provided
+
+### ⚙️ Miscellaneous Tasks
+
+- Add gitignore
+- Init boilerplate project
+- Init index
+- Init tsconfig.json
+- Add prettier
+- Add test script
+- Add build script
+- Add start script with ts-node
+- Add nodemon for dev task with watch support
+- [**breaking**] Rename project to simplelog
+- Add GH and codecov badges
+- Remove useless nodemon.json
+- *(renovate)* Add major approval and develop as base branch
+- *(renovate)* Schedule run during night every weekday
+- Add typing to specs
+- Enable experimentalDecorators
+- Build with specific tsconfig.build
+- *(ts)* Add js extension for nodenext path resolution
+- [**breaking**] Switch to tsx to support ts out of the box
+
+<!-- generated by git-cliff -->

README.md

@@ -4,3 +4,19 @@
 ![Codecov](https://img.shields.io/codecov/c/github/devsheva/simplelog)
 
 A simple logger decorator amplify like
+
+## Important
+
+**Experimental decorators** are used for this package implementation and since experimental it has some bugs like unsafe typing.
+TypeScript compiler complains when it finds out a property used inside a class that calls a decorator cause it cannot infer it, so as a temporary workaround simply declare an interface
+
+```ts
+interface Example {logger: any}
+
+@Logger()
+class Example {
+   hello() {
+    this.logger.debug() // THIS IS VALID
+   }
+}
+```

cliff.toml

@@ -0,0 +1,79 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% 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 | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

package.json

@@ -1,18 +1,19 @@
 {
 	"name": "simplelog",
+	"type": "module",
 	"description": "A simple logging library",
 	"devDependencies": {
 		"@vitest/coverage-v8": "^2.0.5",
 		"nodemon": "^3.1.4",
 		"prettier": "3.3.3",
-		"ts-node": "^10.9.2",
+		"tsx": "^4.19.0",
 		"typescript": "^5.5.4",
 		"vitest": "^2.0.5"
 	},
 	"scripts": {
-		"start": "pnpm ts-node src/index.ts",
-		"dev": "pnpm nodemon src/index.ts",
-		"build": "tsc",
+		"start": "pnpm tsx src/index.ts",
+		"dev": "pnpm tsx watch src/index.ts",
+		"build": "tsc --build tsconfig.build.json",
 		"test": "vitest",
 		"coverage": "vitest run --coverage"
 	}