Skip to content

Commit

Permalink
chore: initial setup
Browse files Browse the repository at this point in the history
  • Loading branch information
czernika committed Nov 25, 2024
0 parents commit 25456ed
Show file tree
Hide file tree
Showing 17 changed files with 585 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = true

[*.yml]
indent_size = 2
42 changes: 42 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Run tests

on:
pull_request:
types:
- opened
push:
branches:
- master
paths:
- '.github/workflows/tests.yml'
- 'bun.lockb'
- '**.ts'

env:
HUSKY: 0

jobs:
unit-tests:
runs-on: ubuntu-22.04
strategy:
fail-fast: true
matrix:
node-version: [18, 20, 22, 23]

name: NodeJS ${{ matrix.node-version }}

steps:
- uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- uses: oven-sh/setup-bun@v1

- name: Install dependencies
run: bun install

- name: Running tests
run: bun test
175 changes: 175 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
9 changes: 9 additions & 0 deletions .husky/install.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* eslint-env node */

// Skip Husky install in CI
// @see https://typicode.github.io/husky/how-to.html
if (process.env.CI === 'true') {
process.exit(0)
}

(await import('husky')).default
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
bunx lint-staged
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Releases
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Ihar Aliakseyenka

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.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Pluralizer

TODO

## Examples

```js
const options = {
single: 'яблоко',
some: 'яблока',
many: 'яблок',
}

pluralizeRu(0, options) // '0 яблок'
pluralizeRu(1, options) // '1 яблоко'
pluralizeRu(2, options) // '2 яблока'
pluralizeRu(11, options) // '11 яблок'
pluralizeRu(33, options) // '11 яблока'
pluralizeRu(50, options) // '50 яблок'
pluralizeRu(51, options) // '51 яблоко'
pluralizeRu(1022, options) // '1022 яблока'

const options = {
single: 'яблоко',
some: 'яблока',
many: 'яблок',
none: 'яблочищ', // zero items
}

pluralizeRu(0, options) // '0 яблочищ'

const options = {
single: 'яблоко',
some: 'яблока',
many: 'яблок',
none: 'яблок',
}

pluralizeRu(0, options, 'Нет') // 'Нет яблок'

const options = {
single: 'яблоко',
some: 'яблока',
many: 'яблок',
none: 'яблок',
}

pluralizeRu(0, options, 0, false) // 'яблок' // do not show amount of items
```
Binary file added bun.lockb
Binary file not shown.
31 changes: 31 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// @ts-check

import eslint from '@eslint/js'
import tseslint from 'typescript-eslint'
import stylisticTs from '@stylistic/eslint-plugin-ts'

export default tseslint.config(
{
ignores: [
'**/node_modules/**',
'**/dist/**',
],
},
eslint.configs.recommended,
tseslint.configs.stylistic,
{
plugins: {
'@stylistic/ts': stylisticTs,
},

// @see https://typescript-eslint.io/rules/
rules: {
'@stylistic/ts/semi': ['warn', 'never'],
'@stylistic/ts/quotes': ['warn', 'single'],
'@stylistic/ts/comma-dangle': ['warn', 'always-multiline'],
'no-console': ['error', {
allow: ['warn', 'error'],
}],
},
},
)
36 changes: 36 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"name": "pluralizer",
"description": "pluralize words depends on amount of items",
"license": "MIT",
"version": "0.1.0",
"module": "./dist/pluralizer.js",
"types": "./dist/index.d.ts",
"type": "module",
"files": [
"dist"
],
"scripts": {
"build": "vite build",
"lint": "eslint ./src",
"lint:fix": "eslint ./src --fix",
"prepare": "node .husky/install.mjs"
},
"lint-staged": {
"*.ts": "eslint --fix"
},
"devDependencies": {
"@eslint/js": "^9.15.0",
"@stylistic/eslint-plugin-ts": "^2.11.0",
"@types/bun": "latest",
"ajv": "^8.17.1",
"eslint": "^9.15.0",
"husky": "^9.1.7",
"lint-staged": "^15.2.10",
"typescript-eslint": "^8.15.0",
"vite": "^5.4.11",
"vite-plugin-dts": "^4.3.0"
},
"peerDependencies": {
"typescript": "^5.7.2"
}
}
5 changes: 5 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { pluralize as pluralizeRu } from '@/pluralizers/ru'

export {
pluralizeRu,
}
Loading

0 comments on commit 25456ed

Please sign in to comment.