IA auto-documentation

Turn hard-to-read code into code readable by anyone in only a few seconds.

Features:

- Auto comments:

Select code and run the command. The code will add comments that explain every part of the selected code.

WINDOWS - LINUX: CTRL+SHIFT+I
MAC: CMD+SHIFT+I

- Example input:

export function mergerArrayObjects(arr1, arr2) {
  if (arr1 && arr2) {
    const temp = [...arr1, ...arr2]
    const res = []
    for (const t of temp) {
      const reps = temp.filter(f => f.key === t.key)
      if (!res.find(f => f.key === t.key)) {
        if (reps) {
          res.push(reps.reduce((p, n) => ({ ...p, ...n }), {}))
        } else {
          res.push(t)
        }
      }
    }
    return res
  }
  if (arr1 && !arr2) return arr1
  if (arr2 && !arr1) return arr2
}

- Example output:

// This function takes two arrays of objects and merges them into one array of objects.
// If there are objects with the same key, the values of the objects are merged.
// If there are no objects with the same key, the objects are added to the array.
// If there is only one array, the array is returned.

export function mergerArrayObjects(arr1, arr2) {
  if (arr1 && arr2) {
    // Create a temporary array with the two arrays.
    const temp = [...arr1, ...arr2]
    // Create an empty array to store the result.
    const res = []
    // Loop through the temporary array.
    for (const t of temp) {
      // Find all objects with the same key.
      const reps = temp.filter(f => f.key === t.key)
      // If the result array does not contain an object with the same key, add the object to the result array.
      if (!res.find(f => f.key === t.key)) {
        // If there are objects with the same key, merge the objects.
        if (reps) {
          res.push(reps.reduce((p, n) => ({ ...p, ...n }), {}))
        } else {
          // If there are no objects with the same key, add the object to the result array.
          res.push(t)
        }
      }
    }
    // Return the result array.
    return res
  }
  // If there is only one array, return the array.
  if (arr1 && !arr2) return arr1
  if (arr2 && !arr1) return arr2
}

- Auto documentation:

Select code and run the command. A Markdown file will be created in the same directory, with the explanation and some examples of how the selected code works.

WINDOWS - LINUX: CTRL+SHIFT+A
MAC: CMD+SHIFT+A

- Example input:

export function mergerArrayObjects(arr1, arr2) {
  if (arr1 && arr2) {
    const temp = [...arr1, ...arr2]
    const res = []
    for (const t of temp) {
      const reps = temp.filter(f => f.key === t.key)
      if (!res.find(f => f.key === t.key)) {
        if (reps) {
          res.push(reps.reduce((p, n) => ({ ...p, ...n }), {}))
        } else {
          res.push(t)
        }
      }
    }
    return res
  }
  if (arr1 && !arr2) return arr1
  if (arr2 && !arr1) return arr2
}

- Example output:

# MergerArrayObjects
This function merges two arrays of objects into one array of objects.

## Parameters
`arr1`: The first array of objects.

`arr2`: The second array of objects.

## Return Value
An array of objects that is the result of merging `arr1` and `arr2`.

## Examples

Merging two arrays of objects:
``` javascript
const arr1 = [
  { key: 'a', value: 1 },
  { key: 'b', value: 2 },
];

const arr2 = [
  { key: 'a', value: 3 },
  { key: 'c', value: 4 },
];

const result = mergerArrayObjects(arr1, arr2);

console.log(result);
// [
//   { key: 'a', value: 1, value: 3 },
//   { key: 'b', value: 2 },
//   { key: 'c', value: 4 },
// ]

// Merging one array of objects:

const arr1 = [
  { key: 'a', value: 1 },
  { key: 'b', value: 2 },
];

const result = mergerArrayObjects(arr1);

console.log(result);
// [
//   { key: 'a', value: 1 },
//   { key: 'b', value: 2 },
// ]