Add funding.yaml for FLOSS fund with initial data (#64)

Co-authored-by: conradolandia <[email protected]>

Author: CAM-Gerlach

package-lock.json

@@ -6,7 +6,8 @@
     "generate-og-images": "node scripts/generate-og-images.js",
     "generate-contrib-data": "node scripts/generate-contrib-data.js",
     "generate-hubspot-data": "node scripts/generate-hubspot-data.js",
-    "prebuild": "npm run generate-og-images && npm run generate-contrib-data && npm run generate-hubspot-data",
+    "generate-funding-schema": "node scripts/generate-funding-schema.js",
+    "prebuild": "npm run generate-og-images && npm run generate-contrib-data && npm run generate-hubspot-data && npm run generate-funding-schema",
     "dev": "npm run prebuild && npx vite dev",
     "build": "npm run prebuild && npx vite build",
     "preview": "npx vite preview",
@@ -19,6 +20,7 @@
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
     "@tailwindcss/typography": "^0.5.15",
     "@types/three": "^0.169.0",
+    "ajv": "^8.17.1",
     "autoprefixer": "^10.4.20",
     "chart.js": "^4.4.7",
     "cookie": "^1.0.2",

package.json

@@ -0,0 +1,108 @@
+// Generate the funding schema from the src/lib/config/data/funding.yaml file and save it to the funding.json file in the project root
+
+import Ajv from "ajv";
+import { promises as fs } from "fs";
+import yaml from "js-yaml";
+import path from "path";
+import { exists } from "./utils.js";
+
+const FUNDING_SCHEMA_URL = "https://fundingjson.org/schema/v1.0.0/funding.schema.json";
+
+/**
+ * Fetch the funding.json schema from the official URL
+ */
+async function fetchFundingSchema() {
+  try {
+    console.log("Fetching funding.json schema...");
+    const response = await fetch(FUNDING_SCHEMA_URL);
+    
+    if (!response.ok) {
+      throw new Error(`Failed to fetch schema: ${response.status} ${response.statusText}`);
+    }
+    
+    return await response.json();
+  } catch (error) {
+    console.error("Error fetching funding schema:", error);
+    throw error;
+  }
+}
+
+/**
+ * JSON Schema validator
+ */
+async function validateFundingData(data, schema) {
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const isValid = validate(data);
+  
+  if (!isValid) {
+    return validate.errors.map(error => `${error.instancePath} ${error.message}`);
+  }
+  
+  return [];
+}
+
+/**
+ * Load and parse the funding YAML file
+ */
+async function loadFundingYaml() {
+  try {
+    console.log("Loading funding.yaml file...");
+    const yamlPath = path.join(process.cwd(), "src", "lib", "config", "data", "funding.yaml");
+    
+    if (!(await exists(yamlPath))) {
+      throw new Error(`Funding YAML file not found at: ${yamlPath}`);
+    }
+
+    const yamlContent = await fs.readFile(yamlPath, 'utf8');
+    const data = yaml.load(yamlContent);
+    
+    console.log("Successfully parsed funding.yaml");
+    return data;
+  } catch (error) {
+    console.error("Error loading funding YAML:", error);
+    throw error;
+  }
+}
+
+/**
+ * Main function to generate the funding.json file
+ */
+async function generateFundingSchema() {
+  try {
+    // Load the YAML data
+    const fundingData = await loadFundingYaml();
+
+    // Fetch and validate against schema
+    const schema = await fetchFundingSchema();
+    console.log("Validating funding data against schema...");
+    
+    const validationErrors = await validateFundingData(fundingData, schema);
+    
+    if (validationErrors.length > 0) {
+      console.error("Schema validation failed:");
+      validationErrors.forEach(error => console.error(`  🚩 ${error}`));
+      throw new Error("Funding data does not comply with schema");
+    }
+
+    console.log("✅ Funding data is valid according to schema");
+
+    // Ensure the output directory exists
+    const outputDir = path.join(process.cwd(), "static");
+    if (!(await exists(outputDir))) {
+      await fs.mkdir(outputDir, { recursive: true });
+    }
+
+    // Write the JSON file
+    const outputPath = path.join(outputDir, "funding.json");
+    await fs.writeFile(outputPath, JSON.stringify(fundingData, null, 2));
+
+    console.log("✅ Funding schema has been successfully generated and saved to:", outputPath);
+  } catch (error) {
+    console.error("Error generating funding schema:", error);
+    process.exit(1);
+  }
+}
+
+// Execute the script
+generateFundingSchema();

scripts/generate-funding-schema.js

@@ -0,0 +1,88 @@
+version: 'v1.0.0'
+entity:
+  type: 'organisation'
+  role: 'other'
+  name: 'Spyder'
+  email: '[email protected]'
+  description: 'The Spyder organization, a project of the NumFOCUS nonprofit'
+  webpageUrl:
+    url: 'https://www.spyder-ide.org'
+projects:
+  - guid: 'spyder-ide'
+    name: 'Spyder'
+    description: 'The scientific Python development environment'
+    webpageUrl:
+      url: 'https://www.spyder-ide.org'
+    repositoryUrl:
+      url: 'https://github.com/spyder-ide'
+      wellKnown: ''
+    licenses: ['spdx:MIT']
+    tags: ['python', 'qt', 'anaconda', 'pyqt5', 'ide', 'language-server-protocol', 'spyder', 'anaconda-distribution', 'winpython']
+  - guid: 'python-lsp'
+    name: 'Python LSP Server'
+    description: 'The python-language-server project, maintained by the Spyder IDE team and the community'
+    webpageUrl:
+      url: 'https://github.com/python-lsp'
+    repositoryUrl:
+      url: 'https://github.com/python-lsp/python-lsp-server'
+      wellKnown: ''
+    licenses: ['spdx:MIT']
+    tags: ['python', 'language-server-protocol', 'lsp', 'ide', 'spyder']
+funding:
+  channels:
+    - guid: 'hubspot'
+      type: 'payment-provider'
+      address: 'https://numfocus.org/donate-for-spyder'
+      description: 'Spyder HubSpot donation page with NumFOCUS'
+    - guid: 'numfocus'
+      type: 'other'
+      address: '[email protected]'
+      description: 'Contact NumFOCUS to coordinate a direct donation'
+  plans:
+    - guid: 'general-fund-onetime'
+      status: 'active'
+      name: 'Support Spyder'
+      description: 'Support the Spyder project as a whole, with the money used where it is needed most.'
+      amount: 0
+      currency: 'USD'
+      frequency: 'one-time'
+      channels: ['hubspot']
+    - guid: 'general-fund-monthly'
+      status: 'active'
+      name: 'Support Spyder'
+      description: 'Support the Spyder project as a whole with a monthly donation, with the money used where it is needed most.'
+      amount: 0
+      currency: 'USD'
+      frequency: 'monthly'
+      channels: ['hubspot']
+    - guid: 'individual'
+      status: 'active'
+      name: 'Individual Donation'
+      description: 'Support us with a monthly donation and help us continue our activities.'
+      amount: 5
+      currency: 'USD'
+      frequency: 'monthly'
+      channels: ['hubspot']
+    - guid: 'company'
+      status: 'active'
+      name: 'Company Sponsor'
+      description: 'Become a sponsor and get your logo on our README on Github with a link to your site.'
+      amount: 100
+      currency: 'USD'
+      frequency: 'monthly'
+      channels: ['hubspot']
+    - guid: 'junior-dev'
+      status: 'active'
+      name: 'Part Time Junior Developer'
+      description: 'Help pay a Junior Developer to work part time on the Spyder IDE.'
+      amount: 500
+      currency: 'USD'
+      frequency: 'monthly'
+      channels: ['hubspot']
+  history:
+    - year: 2024
+      income: 150000
+      expenses: 150000
+      taxes: 0
+      currency: 'USD'
+      description: ''

src/lib/config/data/funding.yaml

@@ -41,7 +41,7 @@
     "type": "User",
     "user_view_type": "public",
     "site_admin": false,
-    "contributions": 2500
+    "contributions": 2504
   },
   {
     "login": "PierreRaybaut",