@actualwave/traceability-matrices - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

commands/serve.js

@@ -39,3 +39,3 @@ const Koa = require("koa");
   router.get("/", (ctx, next) => {
-    ctx.redirect("/files");
+    ctx.redirect("/projects");
   });
@@ -42,0 +42,0 @@

cypress.js

@@ -27,4 +27,2 @@ /**
 
-console.log(projects);
-
 const saveProjectInfo = (project) => {
@@ -31,0 +29,0 @@ const fileName = `${project.title.replace(

markdown.d.ts

 import type { ProjectApi } from "./cypress";
 
+/**
+ * Parse markdown content string and create a prioject from it.
+ * The structure of markdown file is following:
+ * # Project title
+ * Optional paragraph ormultiple paragraphs of project description, may contain links
+ * 
+ * ## Category
+ * - list of requirements
+ * 
+ * @param {string} markdown String of markdown content
+ */
 export declare const parseMarkdownProject: (markdown: string) => ProjectApi;
 
-export declare const createProjectFromMarkdown: (markdown: string) => {
+/**
+ * Since it uses cy.readFile(), it can be executed only within cypress hooks like before().
+ *
+ * @param {string} path Path to markdown file from project root
+ */
+export declare const createProjectFromMarkdown: (path: string) => {
   // Cypress.Chainable<ProjectApi>
   then: (callback: (project: ProjectApi) => void) => void;
 };
+
+/**
+ * It immediately returns empty project and creates a before() hook which reads markdown file.
+ * Once markdown has been read, its content(title, description, structure) merged
+ * with returned project.
+ *
+ * This way we don't need to wait for a promise or wrap it into lifecycle hooks.
+ *
+ * @param {string} path Path to markdown file from project root
+ */
+export declare const createProjectFromMarkdownAsync: (path: string) => ProjectApi;

package.json

 {
   "name": "@actualwave/traceability-matrices",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "types": "cypress.d.ts",
@@ -5,0 +5,0 @@ "bin": {

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

Improved metrics

Total package byte prevSize

604645

increased by0.35%

Lines of code

22702

increased by0.28%

No dependency changes