allure-extras - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -0,1 +1,3 @@
+#!/usr/bin/env node
+
 const axios = require('axios');
@@ -9,2 +11,3 @@ const fs = require('fs');
 async function downloadLatestJar() {
+    console.log("# Downloading new allure jar");
     const repoUrl = 'https://api.github.com/repos/shoaibmansoor/allure2/releases/latest';
@@ -21,5 +24,7 @@ const response = await axios.get(repoUrl);
     fs.writeFileSync(fileName, jarData.data);
+    console.log("# The jar downloaded successfully!");
 }
 
 function checkAllureInstallation() {
+    console.log("# Replacing older version of jar");
     const rootPath = execSync('npm root -g').toString().trim();
@@ -41,2 +46,4 @@ const allureLibPath = path.join(rootPath, 'allure-commandline', 'dist', 'lib');
     fs.copyFileSync(fileName, path.join(allureLibPath, allureGeneratorFile));
+    console.log("# The file has been updated successfully!");
+    console.log("# Voila! the installation is successful!!!");
 }
@@ -43,0 +50,0 @@

package.json

 {
   "name": "allure-extras",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Adding additional capabilites to the Allure report",
   "main": "index.js",
+  "bin": {
+    "allure-extras": "./index.js"
+  },
   "scripts": {
@@ -7,0 +10,0 @@ "test": "echo \"Error: no test specified\" && exit 1"

README.md

@@ -1,7 +0,48 @@
-Allure Extras
+# allure-extras
 
-Adds addtional capabilites to the allure report
+`allure-extras` is an innovative npm package designed to enhance the functionality of Allure reports. It introduces a novel approach to organizing and analyzing test results, especially beneficial for large and complex test suites. By using the `groupBy` tag format, `allure-extras` allows users to categorize and segregate test failures more effectively, providing clearer insights into specific modules or aspects of the application under test.
 
-** New Capabilites **
-- Adding groupBy tags support
+## Features
 
+- **Test Grouping**: Automatically groups test failures based on custom `groupBy` tags for a more organized review process.
+- **Easy Identification**: Simplifies the process of identifying which modules or sections of your tests are failing.
+- **Customizable Tags**: Users can define multiple `groupBy` tags like `groupBy:SOMETHING1`, `groupBy:SOMETHING2`, etc., to categorize tests according to different criteria.
+
+## Installation
+
+Install `allure-extras` globally using npm:
+
+```bash
+npm install -g allure-extras
+```
+
+This global installation allows you to use `allure-extras` across all your projects and integrate it seamlessly into your testing workflow.
+
+## Usage
+Steps to generate updated report:
+1.  Make sure `allure-commandline` is installed globally using `npm i -g allure-commandline
+2. Install `allure-extras` with `npm install -g allure-extras` command
+3. Run `allure-extras` (once only) and it adds additional capabilites to the allure report
+4. Now you can use `allure generate`, `allure serve` commands the way you like
+
+### Tagging Tests
+
+To leverage the full potential of `allure-extras`, ensure your tests are tagged following the `groupBy` format:
+
+```plaintext
+groupBy:ModuleName
+groupBy:Functionality
+groupBy:AnyOtherCriteria
+```
+
+### Viewing Grouped Results
+
+After running your tests, `allure-extras` enhances the Allure report by adding an additional dropdown menu. This menu categorizes the failed tests based on the specified `groupBy` tags, allowing for a quick and easy identification of problem areas in your test suite.
+
+## Contribution
+
+Contributions to `allure-extras` are welcome! If you have suggestions or improvements, feel free to open an issue or submit a pull request on our GitHub repository.
+
+## License
+
+`allure-extras` is released under the [ISC License](LICENSE).

No alert changes

Improved metrics

Total package byte prevSize

5435

increased by86.71%

Lines of code

61

increased by10.91%

Number of lines in readme file

49

increased by512.5%

No dependency changes