elegant-cli - npm Package Compare versions

Comparing version 0.1.10 to 0.1.12

package.json

 {
   "name": "elegant-cli",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "A utility-first CMS framework for rapidly building expressive and elegant static content web applications.",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
@@ -39,2 +39,3 @@ "repository": {
     "@types/node": "^18.15.0",
+    "jest": "^29.5.0",
     "nodemon": "^2.0.21",
@@ -41,0 +42,0 @@ "ts-node": "^10.9.1",

README.md

@@ -11,2 +11,7 @@ <p align="center">
 
+<p align="center">
+<a href="https://github.com/elegantframework/elegant/actions"><img src="https://github.com/elegantframework/elegant/actions/workflows/jest.yml/badge.svg" alt="Build Status"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
+</p>
+
 ------
@@ -13,0 +18,0 @@

source/elegant-docs/docusaurus.config.js

@@ -22,4 +22,4 @@ // @ts-check
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'facebook', // Usually your GitHub org/user name.
-  projectName: 'docusaurus', // Usually your repo name.
+  // organizationName: 'facebook', // Usually your GitHub org/user name.
+  // projectName: 'docusaurus', // Usually your repo name.
 
@@ -44,7 +44,7 @@ onBrokenLinks: 'throw',
           sidebarPath: require.resolve('./sidebars.js'),
-          // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            process.env.APP_REPOSITORY,
+            process.env.APP_REPOSITORY
         },
+        blog: false,
         theme: {
@@ -51,0 +51,0 @@ customCss: require.resolve('./src/css/custom.css'),

source/elegant-docs/package.json

 {
   "name": "elegant-docs",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "private": true,
@@ -5,0 +5,0 @@ "scripts": {

TODO.md

@@ -1,22 +0,20 @@
-- Once the docs project has been created with the cli, wipe it out and do it again
-    - Reinstall it from scratch, and document every step
+- Document how a user creates a new doc file
 
-        - npm install elegant-cli --save-dev
-        - npx elegant-docs-init
-        - npm install
-        - npm run start
+- Create an e2e test that goes to the local host url and verifys the doc exists.. This help validate any future upgrades
 
-- Create some inital docs
+- List some inital features of v1 under the Why Elegant tab
 
-    - Prologue - dir
-        - Release Notes
-        - Contribution guide
-    - Getting Started - dir
-        Installation.md
-        Configuration
+~~~~~~~~~> To offically release v1-alpha
 
-- Follow the laravel docs.. Create a nice starting point for the Elegant starter docs
+    - Write method to take a --dir arg on init
+    - Write jest test to init the docs.. Use the arg above to set and destory the test doc during testing
+x`
+    - Features that would be nice, but not required are below
+        - Add versioning
 
+    - Create an official github release
 
+~~~~~~~~~~~~>
 
+
 - Figure out how to take args.. --docs blog
@@ -27,4 +25,2 @@ - No args is a full basic scaffold
 
-- Write some tests for the initial cli command? To verify it's good and put a build status on the repo
-
 -- DOCUMENT THE DOCS FEATURES!!! How to create pages and stuff. How to set and change config
@@ -38,6 +34,14 @@
 
+- Enable doc versions.
+    - Go back and update any doc links to use the versioning url
+    - Document how a user would set up their own versioning 
+
+- Set up site translations
+    - Document how a user would set up translations
+
+- Take a look back at the example docusaurus docs site, and bring over alot of those features.. How to update your site, the category.json file, markdown features.
+
 - A regular docs init command should download our docs site, but a summarized version of the docs as an example for devs
     - THe docusarus built site should have our Elegant Readme
 
-- Create an init args flag that will allow a user to download our full docs site as an example
 
@@ -44,0 +48,0 @@ - Add built in 508 compliance and testing  - Axe, Jest, Storybook.. Use Aria-labels

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

28

increased by21.74%

Worsened metrics

Total package byte prevSize

675978

decreased by-6.12%

Dev dependency count

5

increased by25%

Number of package files

31

decreased by-16.22%

Lines of code

12717

decreased by-0.06%

No dependency changes