Merge pull request #16 from SecJS/feat/len-add-secjs-exceptions

feat: Add @secjs/exceptions and CI

Author: jlenon7

.github/workflows/cd.yml

@@ -22,10 +22,10 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Download dependencies
-        run: yarn
+        run: npm install
 
       - name: Transpile typescript to javascript
-        run: yarn build
+        run: npm run build
 
       - name: Automatic GitHub Release
         uses: justincy/github-action-npm-release@2.0.1

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI Base
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Download dependencies
+        run: npm install
+
+      - name: Verify project lint and try to fix it
+        run: npm run lint:fix

.gitignore

@@ -1,10 +1,13 @@
+node_modules/
+dist/
 # Logs
 logs
 *.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -38,11 +41,10 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
 
 # TypeScript cache
 *.tsbuildinfo
@@ -68,23 +70,21 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
-.env
-.env.test
-
 # parcel-bundler cache (https://parceljs.org/)
 .cache
+.parcel-cache
 
 # Next.js build output
 .next
+out
 
 # Nuxt.js build / generate output
 .nuxt
 dist
 
 # Gatsby files
 .cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# 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
 
@@ -103,6 +103,21 @@ dist
 # TernJS port file
 .tern-port
 
-*.js
-*.d.ts
+# 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.*
+
+# IDE
 .idea
+.vscode
+
+# dotenv environment variables file
+.env
+.env.testing
+.env.production

README.md

@@ -19,6 +19,15 @@ The intention behind this repository is to always maintain a `Base` project to a
 
 ## Installation
 
+> To use the high pottential from @secjs/base you need to install first this packages from SecJS, 
+> it keeps as dev dependency because one day @secjs/core will install everything once.
+
+```bash
+npm install @secjs/contracts @secjs/exceptions @secjs/utils
+```
+
+> Than you can install @secjs/base
+
 ```bash
 npm install @secjs/base
 ```
@@ -138,6 +147,4 @@ class UserRepository extends PrismaRepository<User> {
 
 ---
 
-## License
-
 Made with 🖤 by [jlenon7](https://github.com/jlenon7) :wave:

index.ts

@@ -1,5 +1,6 @@
 export * from './services/BaseService'
 export * from './services/GuardBaseService'
+
 export * from './repositories/LucidRepository'
 export * from './repositories/PrismaRepository'
 export * from './repositories/TypeOrmRepository'