Skip to content

Commit

Permalink
feat: upgrade library
Browse files Browse the repository at this point in the history
* docs: improve generated documentation
* ci: use create-ts-lib-gh
* fix(deps): remove strict peerDependency locks
  • Loading branch information
glebbash authored Aug 5, 2022
1 parent 79e615b commit a0a8e54
Show file tree
Hide file tree
Showing 20 changed files with 16,018 additions and 7,486 deletions.
2 changes: 0 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#root = true

[*]
indent_style = space
end_of_line = lf
Expand Down
10 changes: 7 additions & 3 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
parser: "@typescript-eslint/parser"
parser: '@typescript-eslint/parser'
extends:
- plugin:@typescript-eslint/recommended
- prettier/@typescript-eslint
- plugin:prettier/recommended

plugins:
- simple-import-sort

parserOptions:
ecmaVersion: 2018
sourceType: module

rules: {}
rules:
simple-import-sort/imports: error
simple-import-sort/exports: error
25 changes: 17 additions & 8 deletions .github/workflows/workflow.yml → .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
name: Test and Publish
name: build
on: ["push", "pull_request"]

jobs:
test:
name: Build and test
runs-on: ubuntu-20.04
name: Test
runs-on: ubuntu-latest
strategy:
matrix:
node: [14, 16]
steps:
- uses: actions/checkout@v1

- name: Use Node.js 14
- name: Use Node.js ${{ matrix.node }}
uses: actions/setup-node@v1
with:
node-version: 14
node-version: ${{ matrix.node }}

- name: Update npm
if: matrix.node == 14
run: |
npm i -g npm@latest
- name: Test and generate coverage
run: |
npm ci
npm run test:prod
npm run test:ci
- name: Coveralls
if: matrix.node == 16
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -35,10 +44,10 @@ jobs:
with:
fetch-depth: 0

- name: Use Node.js 14
- name: Use Node.js 16
uses: actions/setup-node@v1
with:
node-version: 14
node-version: 16

- name: Install dependencies
run: |
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ node_modules
*.log
.vscode
.idea
dist
lib
compiled
.awcache
.rpt2_cache
Expand Down
1 change: 0 additions & 1 deletion .husky/.gitignore

This file was deleted.

Empty file modified .husky/pre-push
100644 → 100755
Empty file.
1 change: 0 additions & 1 deletion .prettierrc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
semi: true
singleQuote: true
proseWrap: always
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2021 glebbash <[email protected]>
Copyright 2022 glebbash <[email protected]>

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:

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
<strong>Wrapper for NestJS / Fireorm</strong>
</p>

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Source](https://img.shields.io/badge/source-github-informational)](https://github.com/glebbash/nestjs-fireorm)
[![Deploy](https://github.com/glebbash/nestjs-fireorm/actions/workflows/build.yml/badge.svg)](https://github.com/glebbash/nestjs-fireorm/actions)
[![Coverage Status](https://coveralls.io/repos/github/glebbash/nestjs-fireorm/badge.svg?branch=master)](https://coveralls.io/github/glebbash/nestjs-fireorm?branch=master)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

`nestjs-fireorm` is a tiny [Nest.js][] [Fireorm][] module.

> Fireorm 🔥 is a tiny wrapper on top of firebase-admin that makes life easier when dealing with a
> Fireorm 🔥 is a tiny wrapper on top of firestore that makes life easier when dealing with a
> Firestore database.
This module makes it easier to deal with Firestore database when using Nest.js!
Expand Down Expand Up @@ -109,4 +109,6 @@ Apart from this README, you can find examples of using the library in the follow

[example usage]: https://github.com/glebbash/nestjs-fireorm/tree/master/example/src

[Mit Licensed](LICENSE)
Bootstrapped with: [create-ts-lib-gh](https://github.com/glebbash/create-ts-lib-gh)

This project is [MIT Licensed](LICENSE).
2 changes: 0 additions & 2 deletions example/src/app.module.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
import { Module } from '@nestjs/common';
import { credential } from 'firebase-admin';
import { FireormModule } from 'nestjs-fireorm';

@Module({
imports: [
FireormModule.forRoot({
firestoreSettings: {
projectId: '<project_id>',
credential: credential.applicationDefault(),
},
fireormSettings: { validateModels: true },
}),
Expand Down
Loading

0 comments on commit a0a8e54

Please sign in to comment.