oss-sustain-guard/.oss-sustain-guard.toml at main · onukura/oss-sustain-guard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
[tool.oss-sustain-guard]
# Exclude specific packages from analysis
exclude = []

# Default output format style: "compact", "normal", or "detail"
# output_style = "normal"

# Enable verbose logging by default
# verbose = false

# Directory exclusion settings for recursive scanning
[tool.oss-sustain-guard.exclude-dirs]
# Additional directory patterns to exclude (in addition to defaults)
patterns = []

# Use default exclusions (node_modules, venv, __pycache__, etc.)
# Default: true
use_defaults = true

# Respect .gitignore patterns when scanning directories
# Default: true
use_gitignore = true

# Scoring profiles for health assessment
# You can define custom profiles here instead of using --profile-file
# Each profile assigns weights to individual metrics (integers ≥1)
# Available profiles: balanced (default), security_first, contributor_experience, long_term_stability
#
# Example custom profile (uncomment to use):
# [tool.oss-sustain-guard.profiles.my_custom]
# name = "My Custom Profile"
# description = "Custom scoring focused on specific needs"
#
# [tool.oss-sustain-guard.profiles.my_custom.weights]
# "Contributor Redundancy" = 5
# "Maintainer Retention" = 4
# "Contributor Attraction" = 3
# "Contributor Retention" = 3
# "Organizational Diversity" = 2
# "Maintainer Load Distribution" = 2
# "Recent Activity" = 3
# "Release Rhythm" = 2
# "Build Health" = 2
# "Change Request Resolution" = 1
# "Issue Responsiveness" = 2
# "PR Acceptance Ratio" = 2
# "Review Health" = 2
# "Issue Resolution Duration" = 1
# "Stale Issue Ratio" = 1
# "PR Merge Speed" = 2
# "Documentation Presence" = 2
# "Code of Conduct" = 1
# "License Clarity" = 2
# "Project Popularity" = 1
# "Fork Activity" = 1
# "Security Signals" = 4
# "Funding Signals" = 3
# "PR Responsiveness" = 2

# LFX Insights Integration
# Enable/disable LFX Insights badges and links in reports
[tool.oss-sustain-guard.integrations.lfx]
# Enable LFX Insights integration
enabled = true

# Badge types to display in reports
# Available: "health-score", "active-contributors", "contributors"
badges = ["health-score", "active-contributors"]

# Explicit package to LFX project slug mapping
# This is the most reliable way to ensure correct LFX links
# Format: "ecosystem:package" = "lfx-project-slug"
#
# Examples:
# [tool.oss-sustain-guard.integrations.lfx.project_map]
# "npm:react" = "facebook-react"
# "pypi:requests" = "psf-requests"
# "github:kubernetes/kubernetes" = "kubernetes-kubernetes"