Skip to content

Commit

Permalink
feat: bootstrap package
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuelgautier committed Oct 15, 2024
1 parent 74486bd commit 92e1bd2
Show file tree
Hide file tree
Showing 17 changed files with 6,031 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = false
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**/*.d.ts
dist/**/*
.github
14 changes: 14 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
module.exports = {
parser: '@typescript-eslint/parser',
extends: ['plugin:@typescript-eslint/recommended', 'prettier'],
plugins: ['@typescript-eslint', 'prettier'],
'overrides': [
{
'files': ['tests/**/*'],
'env': {
'jest': true
}
}
],
rules: {},
};
42 changes: 42 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: ci

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
ci:
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
node: ["lts/hydrogen", "lts/iron", "21", "22"]

name: Node ${{ matrix.node }}

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

- name: Setup node env 🏗
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
cache: "npm"

- name: Install dependencies 👨🏻‍💻
run: npm ci

- name: Lint code 🧹
run: npm run lint

- name: Run tests 🧪
run: npm run test

- name: Run builds 🛠
run: npm run build
55 changes: 55 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Logs
logs
*.log
npm-debug.log*

# 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

# Dependency directories
node_modules/
jspm_packages/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# build / generate output
dist

# Stores VSCode versions used for testing VSCode extensions
.vscode-test
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm test
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/hydrogen
8 changes: 8 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Directories
dist
node_modules
.github

# Files
README.md
package-lock.json
5 changes: 5 additions & 0 deletions .prettierrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
semi: true,
singleQuote: true,
trailingComma: 'es5',
};
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Domain Connect Node.js client

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/domchekr/domainconnect-node/main.yml?branch=main&label=core%20build&style=for-the-badge)](https://github.com/domchekr/domainconnect-node/actions/workflows/main.yml)
![Latest version](https://img.shields.io/github/v/release/domchekr/domainconnect-node?sort=semver&style=for-the-badge)
[![Github Repo Stars](https://img.shields.io/github/stars/domchekr/domainconnect-node?style=for-the-badge)](https://github.com/domchekr/domainconnect-node)
![License](https://img.shields.io/github/license/domchekr/domainconnect-node?style=for-the-badge)
[![NPM](https://img.shields.io/npm/v/@domchekr/domainconnect?style=for-the-badge)](https://www.npmjs.com/package/@domchekr/domainconnect)

Node.js client library for the Domain Connect protocol.

## Installation

Install the `@domchekr/domainconnect` package using your preferred package manager:

```sh
# npm
npm i --save @domchekr/domainconnect

# yarn
yarn add @domchekr/domainconnect

# pnpm
pnpm i @domchekr/domainconnect
```

If you run into any issues, [feel free to report them to us on GitHub](https://github.com/domchekr/domainconnect-node/issues).

## Getting started

Coming soon

## License

MIT © [DomChekr](https://www.domcheckr.com/)
10 changes: 10 additions & 0 deletions jest.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
moduleFileExtensions: ['ts', 'js', 'json', 'node'],
transform: {
'^.+\\.(ts|tsx)$': 'ts-jest',
'^.+\\.(js|jsx)$': 'babel-jest',
},
};
Loading

0 comments on commit 92e1bd2

Please sign in to comment.