Merge pull request #2 from sineverba/develop

Develop

.circleci/config.yml

@@ -0,0 +1,17 @@
+version: 2.1
+jobs:
+
+  test:
+    docker:
+      - image: cimg/node:18.14.2
+
+    steps:
+      - checkout
+      - run: npm ci
+      - run: npm run test
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

.gitignore

@@ -0,0 +1,10 @@
+coverage
+node_modules
+build
+npm-debug.log
+.env
+.DS_Store
+.npmrc
+.nyc_output
+.scannerwork
+dist/

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run prettier

.nvmrc

@@ -0,0 +1 @@
+v18.14.2

.semaphore/build-deploy.yml

@@ -0,0 +1,23 @@
+version: v1.0
+
+name: Deploy to NPM
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+
+global_job_config:
+  secrets:
+    - name: ACCESS_TOKENS
+
+blocks:
+  - name: Deploy
+    task:
+      jobs:
+        - name: Deploy
+          commands:
+            - checkout
+            - npm ci
+            - npm run build
+            - mv npmrc.txt .npmrc
+            - npm publish

.semaphore/semaphore.yml

@@ -0,0 +1,81 @@
+version: v1.0
+
+name: Build and test
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+
+global_job_config:
+  env_vars:
+    - name: SONARSCANNER_VERSION
+      value: 4.8.0
+  secrets:
+    - name: ACCESS_TOKENS
+
+blocks:
+  - name: Install dependencies
+    skip:
+      when: "tag =~ '.*'"
+    task:
+      jobs:
+        - name: 'Install'
+          commands:
+            - checkout
+            - cache restore
+            - npm ci
+            - cache store
+
+  - name: Test
+    skip:
+      when: "tag =~ '.*'"
+    task:
+      prologue:
+        commands:
+          - checkout
+          - cache restore
+      jobs:
+        - name: Test
+          matrix:
+            - env_var: NODE_VERSION
+              values: [ "14", "16", "18" ]
+          commands:
+            - sem-version node $NODE_VERSION
+            - npx jest
+        - name: Prettier
+          commands:
+            - rm -r node_modules/
+            - nvm install
+            - nvm use
+            - npm ci
+            - npm run prettier
+
+  - name: Coverage
+    skip:
+      when: "tag =~ '.*'"
+    task:
+      prologue:
+        commands:
+          - checkout
+          - cache restore
+          - npm run coverage
+      jobs:
+      - name: Coverage
+        commands:
+          - export COVERALLS_REPO_TOKEN=$COVERALLS_NPM_PKG_CONCATENATE
+          - cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js
+      - name: Sonarcloud
+        commands:
+          - >-
+            docker run 
+            --rm
+            -e SONAR_HOST_URL="https://sonarcloud.io"
+            -e SONAR_LOGIN=$SONAR_TOKEN
+            -v "/home/semaphore/npm-pkg-year-interval:/usr/src"
+            sonarsource/sonar-scanner-cli:$SONARSCANNER_VERSION
+
+promotions:
+  - name: Deploy
+    pipeline_file: build-deploy.yml
+    auto_promote:
+      when: "result = 'passed' and tag =~ '.*'"

CHANGELOG.md

@@ -1,2 +1,4 @@
 # Next version
 + First commit
++ Add code
++ Fix jest watch for Semaphore

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 2634842+sineverba@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**. This page details how to 
+contribute and the expected code quality for all contributions.
+
+## Pull Requests
+
+We accept contributions via Pull Requests.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests. Continuous Integrations are enabled, so your PR need to pass them before accepted.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+   - Create a branch `feature-myawesomefeature` or `hotfix-myhotfix` from `develop`
+   - Push your branch against `develop` branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+
+**Happy coding**!

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2023 sineverba
+
+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.

Makefile

@@ -0,0 +1,15 @@
+SONARSCANNER_VERSION=4.8.0
+
+sonar:
+	docker run --rm -it \
+		--name sonarscanner \
+		-v $(PWD):/usr/src \
+		-e SONAR_HOST_URL=$(SONAR_HOST_URL) \
+		-e SONAR_LOGIN=$(SONAR_TOKEN) \
+		sonarsource/sonar-scanner-cli:$(SONARSCANNER_VERSION)
+
+upgrade:
+	npx ncu --doctor -u
+	npm install
+	npx browserslist@latest --update-db
+	npm audit fix

README.md

@@ -0,0 +1,37 @@
+Concatenate
+===========
+
+| CI / CD | Status |
+| ------- | ------ |
+| NPM | TBD |
+| Semaphore CI | [![Build Status](https://sineverba.semaphoreci.com/badges/npm-pkg-concatenate/branches/master.svg?style=shields&key=39b8f9bd-3213-4836-a1b3-ca116c91a9e9)](https://sineverba.semaphoreci.com/projects/npm-pkg-concatenate) |
+| Circle CI | TBD |
+| Coverall | [![Coverage Status](https://coveralls.io/repos/github/sineverba/npm-pkg-concatenate/badge.svg?branch=master)](https://coveralls.io/github/sineverba/npm-pkg-concatenate?branch=master) |
+| SonarCloud | TBD |
+
+`concatenate` returns a single string starting from two strings. If first (or second) string are empty, it returns the other one.
+
+## Why is it useful?
+
+I use it in a name + surname concatenation, if one of them can be empty. E.g. "Alex" + "" doesn't return "Alex " (note the space!) but "Alex".
+
+### Installation
+`npm install @sineverba/concatenate`
+
+### Usage
+
+```js
+import { concatenate } from "shortfield";
+
+const name = " ";
+const surname = "Foo";
+
+const result = concatenate(name, surname);
+console.log(result); // prints Foo
+```
+
+#### Tests
+
+`npm run test` for simple test
+
+`npm run cover` for coverage

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

npmrc.txt

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}