✨ Support workspace Cargo.toml with package section

This commit also introduce:
- ✅ Unit test for previous behavior
- 🐛 make description optional field like in other package

Author: OlivierLDff

packages/gitmoji-changelog-cli/src/presets/cargo.js

@@ -1,6 +1,26 @@
 const toml = require('toml')
 const fs = require('fs')
 
+function configFromPackage(tomlEntry) {
+  let config = {
+    name: tomlEntry.name,
+    version: tomlEntry.version,
+    description: tomlEntry.description,
+  }
+
+  if (!config.name) {
+    throw new Error('Could not find name metadata in Cargo.toml')
+  }
+  if (!config.version) {
+    throw new Error('Could not find version metadata in Cargo.toml')
+  }
+  if (!config.description) {
+    config.description = ''
+  }
+
+  return config
+}
+
 module.exports = async () => {
   try {
     const cargoPromise = new Promise((resolve, reject) => {
@@ -11,18 +31,22 @@ module.exports = async () => {
       }
     })
 
-    const {
-      package: {
-        name,
-        version,
-        description,
-      },
-    } = await cargoPromise
-    return {
-      name: name,
-      version: version,
-      description: description,
+    let cargoToml = await cargoPromise
+    if (!cargoToml) {
+      throw new Error('Cargo.toml is empty')
+    }
+
+    // Check if the package section exists, it means it's a Cargo.toml file
+    if (cargoToml.package) {
+      return configFromPackage(cargoToml.package)
+    } if (cargoToml.workspace) {
+      const workspace = cargoToml.workspace
+      if (!workspace.package) {
+        throw new Error("Cargo.toml workspace doesn't have a package section")
+      }
+      return configFromPackage(workspace.package)
     }
+    throw Error("Cargo.toml doesn't have a package or workspace section")
   } catch (e) {
     return null
   }

packages/gitmoji-changelog-cli/src/presets/cargo.spec.js

@@ -0,0 +1,66 @@
+const fs = require('fs')
+
+const loadProjectInfo = require('./cargo.js')
+
+describe('getPackageInfo', () => {
+  it('should extract metadata from a Cargo.toml that is a crate', async () => {
+    // Reference content from https://doc.rust-lang.org/cargo/reference/manifest.html#the-package-section
+    fs.readFileSync.mockReturnValue(`
+      [package]
+      name = "hello_world" # the name of the package
+      version = "0.1.0"    # the current version, obeying semver
+      authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
+      description = "A sample project"
+    `)
+
+    const result = await loadProjectInfo()
+
+    expect(result).toEqual({
+      name: 'hello_world',
+      version: '0.1.0',
+      description: 'A sample project',
+    })
+  })
+
+  it('should extract metadata from a Cargo.toml with missing description', async () => {
+    fs.readFileSync.mockReturnValue(`
+      [package]
+      name = "no-description" # the name of the package
+      version = "0.0.1"    # the current version, obeying semver
+    `)
+
+    const result = await loadProjectInfo()
+
+    expect(result).toEqual({
+      name: 'no-description',
+      version: '0.0.1',
+      description: '',
+    })
+  })
+
+  it('should extract metadata from a Cargo.toml that is a workspace', async () => {
+    // Reference content from https://doc.rust-lang.org/cargo/reference/workspaces.html#the-package-table
+    fs.readFileSync.mockReturnValue(`
+      [workspace]
+      members = ["bar"]
+
+      [workspace.package]
+      name = "hello_world"
+      version = "1.2.3"
+      authors = ["Nice Folks"]
+      description = "A short description of my package"
+      documentation = "https://example.com/bar"
+    `)
+
+    const result = await loadProjectInfo()
+
+    expect(result).toEqual({
+      name: 'hello_world',
+      version: '1.2.3',
+      description: 'A short description of my package',
+    })
+  })
+})
+
+
+jest.mock('fs')