From d6481527dd22892c0cc2121aa0fba2436e335f1c Mon Sep 17 00:00:00 2001 From: James Brumond Date: Sat, 26 Aug 2023 18:55:27 -0700 Subject: [PATCH] setup repo --- .gitea/workflows/build-and-publish.yaml | 4 ++-- .gitea/workflows/build-and-test.yaml | 4 ++-- package-lock.json | 8 +++---- package.json | 8 +++---- readme.md | 28 ++++++++++--------------- 5 files changed, 23 insertions(+), 29 deletions(-) diff --git a/.gitea/workflows/build-and-publish.yaml b/.gitea/workflows/build-and-publish.yaml index aa31aff..00c4f21 100644 --- a/.gitea/workflows/build-and-publish.yaml +++ b/.gitea/workflows/build-and-publish.yaml @@ -23,8 +23,8 @@ jobs: - name: Login to package registry run: | - npm config set @:registry https://gitea.jbrumond.me/api/packages//npm/ - npm config set -- '//gitea.jbrumond.me/api/packages//npm/:_authToken' "$NPM_PUBLISH_TOKEN" + npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/ + npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN" - name: Install dependencies run: npm ci diff --git a/.gitea/workflows/build-and-test.yaml b/.gitea/workflows/build-and-test.yaml index 3f97cd5..f074919 100644 --- a/.gitea/workflows/build-and-test.yaml +++ b/.gitea/workflows/build-and-test.yaml @@ -26,8 +26,8 @@ jobs: - name: Login to package registry run: | - npm config set @:registry https://gitea.jbrumond.me/api/packages//npm/ - npm config set -- '//gitea.jbrumond.me/api/packages//npm/:_authToken' "$NPM_PUBLISH_TOKEN" + npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/ + npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN" - name: Install dependencies run: npm ci diff --git a/package-lock.json b/package-lock.json index b8d09b5..9942ccb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "@templates/typescript-library", - "version": "1.0.0", + "name": "@js/oidc-login", + "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@templates/typescript-library", - "version": "1.0.0", + "name": "@js/oidc-login", + "version": "0.1.0", "license": "ISC", "devDependencies": { "typescript": "^5.1.3" diff --git a/package.json b/package.json index ded3a6d..96138a0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@templates/typescript-library", - "version": "1.0.0", - "description": "Template project for creating new TypeScript library packages", + "name": "@js/oidc-login", + "version": "0.1.0", + "description": "Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services", "main": "build/index.js", "types": "build/index.d.ts", "scripts": { @@ -13,7 +13,7 @@ }, "repository": { "type": "git", - "url": "https://gitea.jbrumond.me/templates/typescript-library.git" + "url": "https://gitea.jbrumond.me/js/oidc-login.git" }, "author": "James Brumond ", "license": "ISC", diff --git a/readme.md b/readme.md index 7389046..ccdd95e 100644 --- a/readme.md +++ b/readme.md @@ -1,30 +1,24 @@ -Template project for creating new TypeScript library packages +Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services --- -## Get Started - -### Pull down the code +## Install ```bash -git init -git pull https://gitea.jbrumond.me/templates/typescript-library.git master -``` +# Update project npm config to refer to correct registry for the @js scope +echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc -### Update configuration +npm install --save @js/oidc-login -- In `package.json`, update any fields like `name`, `description`, `repository`, etc. -- In `.gitea/workflows/publish.yaml`, update `` placeholders - - - -## Building - -```bash -npm run tsc +# optional - additional supporting typescript definitions +npm install --save-dev @js/types ``` +## Usage +```ts +import { } from '@js/oidc-login'; +```