Merge pull request #1 from primno/doc

Publish package to npm

Author: xaviermonin

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '18.x'
+          
+      - name: Install dependencies and build
+        run: |
+          npm ci
+          npm run build

.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish Core
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.gitignore

@@ -21,7 +21,7 @@ node_modules/
 .pnp.*
 
 # Primno CLI
-dist/tsc.js
+dist/tsc.mjs
 build/
 .nyc_output
 .cache

.npmrc

@@ -0,0 +1,2 @@
+# .npmrc
+engine-strict=true

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Primno
+Copyright (c) 2023 Xavier Monin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,21 @@
 # Primno CLI
 
-Primno CLI is used to manage Primno project from the command line.
+[![npm](https://img.shields.io/npm/v/@primno/cli.svg)](https://www.npmjs.com/package/@primno/cli)
+[![npm](https://img.shields.io/npm/l/@primno/cli.svg)](https://github.com/primno/cli/blob/main/LICENSE)
+![build](https://img.shields.io/github/actions/workflow/status/primno/cli/build.yml)
+
+Primno CLI is a command-line interface tool for initializing, building, and deploying Primno projects from a command shell.
+
+> **Important**
+> primno is in beta stage and subject to change.
+
+## Documentation
+
+The documentation can be found on [https://primno.io](https://primno.io).
+
+- [Getting Started](https://primno.io/docs/getting-started)
+- [Guides](https://primno.io/docs/guides)
+- [API Reference](https://primno.io/docs/api-reference)
 
 ## Commands
 

dist/index.js dist/index.mjsdist/index.js renamed to dist/index.mjs

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('./tsc.js');
+import './tsc.mjs';

dist/schema/primno.json

@@ -31,18 +31,18 @@
                 "build": {
                     "$ref": "#/definitions/Build"
                 },
-                "environnement": {
+                "environment": {
                     "type": "array",
                     "items": {
-                        "$ref": "#/definitions/Environnement"
+                        "$ref": "#/definitions/Environment"
                     }
                 }
             },
             "required": [
                 "build",
                 "distDir",
                 "entryPointDir",
-                "environnement",
+                "environment",
                 "name",
                 "serve",
                 "sourceRoot",
@@ -54,7 +54,7 @@
             "type": "object",
             "additionalProperties": false,
             "properties": {
-                "environnement": {
+                "environment": {
                     "type": "string"
                 },
                 "entryPoint": {
@@ -66,11 +66,11 @@
             },
             "required": [
                 "entryPoint",
-                "environnement"
+                "environment"
             ],
             "title": "Build"
         },
-        "Environnement": {
+        "Environment": {
             "type": "object",
             "additionalProperties": false,
             "properties": {
@@ -89,7 +89,7 @@
                 "name",
                 "production"
             ],
-            "title": "Environnement"
+            "title": "Environment"
         },
         "Serve": {
             "type": "object",

dist/template/new/.gitignore

@@ -0,0 +1,11 @@
+# Node.js
+node_modules/
+
+# VSCode
+.vscode/
+
+# Primno
+.cache
+dist
+build
+primno.env.json

dist/template/new/.npmrc

@@ -0,0 +1,2 @@
+# .npmrc
+engine-strict=true