@taimos/projen 0.1.84 → 0.1.86

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -753,6 +753,255 @@
753
753
  ],
754
754
  "symbolId": "src/components/production-release:GitHubProductionReleaseOptions"
755
755
  },
756
+ "@taimos/projen.Gitleaks": {
757
+ "assembly": "@taimos/projen",
758
+ "base": "projen.Component",
759
+ "docs": {
760
+ "remarks": "projen has no native gitleaks component, so both artifacts are generated here\nto stay in the \"never hand-edit generated files\" model. Requires GitHub to be\nenabled on the project.",
761
+ "stability": "stable",
762
+ "summary": "gitleaks secret-scanning for a project: a `.gitleaks.toml` config that extends the bundled default ruleset plus tightly path-scoped allowlists, and a pull-request workflow that scans the full git history against it."
763
+ },
764
+ "fqn": "@taimos/projen.Gitleaks",
765
+ "initializer": {
766
+ "docs": {
767
+ "stability": "stable"
768
+ },
769
+ "locationInModule": {
770
+ "filename": "src/components/gitleaks.ts",
771
+ "line": 74
772
+ },
773
+ "parameters": [
774
+ {
775
+ "name": "scope",
776
+ "type": {
777
+ "fqn": "projen.typescript.TypeScriptProject"
778
+ }
779
+ },
780
+ {
781
+ "name": "options",
782
+ "optional": true,
783
+ "type": {
784
+ "fqn": "@taimos/projen.GitleaksOptions"
785
+ }
786
+ }
787
+ ]
788
+ },
789
+ "kind": "class",
790
+ "locationInModule": {
791
+ "filename": "src/components/gitleaks.ts",
792
+ "line": 66
793
+ },
794
+ "name": "Gitleaks",
795
+ "properties": [
796
+ {
797
+ "docs": {
798
+ "stability": "stable",
799
+ "summary": "The generated `.gitleaks.toml`."
800
+ },
801
+ "immutable": true,
802
+ "locationInModule": {
803
+ "filename": "src/components/gitleaks.ts",
804
+ "line": 69
805
+ },
806
+ "name": "configFile",
807
+ "type": {
808
+ "fqn": "projen.TextFile"
809
+ }
810
+ },
811
+ {
812
+ "docs": {
813
+ "stability": "stable",
814
+ "summary": "The generated pull-request scanning workflow."
815
+ },
816
+ "immutable": true,
817
+ "locationInModule": {
818
+ "filename": "src/components/gitleaks.ts",
819
+ "line": 72
820
+ },
821
+ "name": "workflow",
822
+ "type": {
823
+ "fqn": "projen.github.GithubWorkflow"
824
+ }
825
+ }
826
+ ],
827
+ "symbolId": "src/components/gitleaks:Gitleaks"
828
+ },
829
+ "@taimos/projen.GitleaksAllowlist": {
830
+ "assembly": "@taimos/projen",
831
+ "datatype": true,
832
+ "docs": {
833
+ "remarks": "Each entry is rendered as a `[[allowlists]]` block. Keep every allowlist as\ntightly path-scoped as possible so it cannot mask a real secret elsewhere in\nthe repo.",
834
+ "stability": "stable",
835
+ "summary": "One path-scoped allowlist entry for the generated `.gitleaks.toml`."
836
+ },
837
+ "fqn": "@taimos/projen.GitleaksAllowlist",
838
+ "kind": "interface",
839
+ "locationInModule": {
840
+ "filename": "src/components/gitleaks.ts",
841
+ "line": 10
842
+ },
843
+ "name": "GitleaksAllowlist",
844
+ "properties": [
845
+ {
846
+ "abstract": true,
847
+ "docs": {
848
+ "stability": "stable",
849
+ "summary": "Human-readable description of what this allowlist exempts and why."
850
+ },
851
+ "immutable": true,
852
+ "locationInModule": {
853
+ "filename": "src/components/gitleaks.ts",
854
+ "line": 12
855
+ },
856
+ "name": "description",
857
+ "type": {
858
+ "primitive": "string"
859
+ }
860
+ },
861
+ {
862
+ "abstract": true,
863
+ "docs": {
864
+ "default": "- gitleaks default (OR)",
865
+ "stability": "stable",
866
+ "summary": "gitleaks `condition` combining `paths` and `regexes` (`AND` requires both)."
867
+ },
868
+ "immutable": true,
869
+ "locationInModule": {
870
+ "filename": "src/components/gitleaks.ts",
871
+ "line": 32
872
+ },
873
+ "name": "condition",
874
+ "optional": true,
875
+ "type": {
876
+ "primitive": "string"
877
+ }
878
+ },
879
+ {
880
+ "abstract": true,
881
+ "docs": {
882
+ "default": "- no path scope",
883
+ "stability": "stable",
884
+ "summary": "Regex paths the allowlist applies to (rendered as gitleaks `paths`), e.g. `['^\\\\.npmrc$']`. Omit to apply the regexes repo-wide (discouraged)."
885
+ },
886
+ "immutable": true,
887
+ "locationInModule": {
888
+ "filename": "src/components/gitleaks.ts",
889
+ "line": 19
890
+ },
891
+ "name": "paths",
892
+ "optional": true,
893
+ "type": {
894
+ "collection": {
895
+ "elementtype": {
896
+ "primitive": "string"
897
+ },
898
+ "kind": "array"
899
+ }
900
+ }
901
+ },
902
+ {
903
+ "abstract": true,
904
+ "docs": {
905
+ "default": "- no value regexes",
906
+ "remarks": "Omit to allow anything on the scoped paths.",
907
+ "stability": "stable",
908
+ "summary": "Regexes matching the allowed secret values (rendered as gitleaks `regexes`)."
909
+ },
910
+ "immutable": true,
911
+ "locationInModule": {
912
+ "filename": "src/components/gitleaks.ts",
913
+ "line": 26
914
+ },
915
+ "name": "regexes",
916
+ "optional": true,
917
+ "type": {
918
+ "collection": {
919
+ "elementtype": {
920
+ "primitive": "string"
921
+ },
922
+ "kind": "array"
923
+ }
924
+ }
925
+ },
926
+ {
927
+ "abstract": true,
928
+ "docs": {
929
+ "default": "- gitleaks default",
930
+ "stability": "stable",
931
+ "summary": "gitleaks `regexTarget` (`secret` | `match` | `line`)."
932
+ },
933
+ "immutable": true,
934
+ "locationInModule": {
935
+ "filename": "src/components/gitleaks.ts",
936
+ "line": 38
937
+ },
938
+ "name": "regexTarget",
939
+ "optional": true,
940
+ "type": {
941
+ "primitive": "string"
942
+ }
943
+ }
944
+ ],
945
+ "symbolId": "src/components/gitleaks:GitleaksAllowlist"
946
+ },
947
+ "@taimos/projen.GitleaksOptions": {
948
+ "assembly": "@taimos/projen",
949
+ "datatype": true,
950
+ "docs": {
951
+ "stability": "stable"
952
+ },
953
+ "fqn": "@taimos/projen.GitleaksOptions",
954
+ "kind": "interface",
955
+ "locationInModule": {
956
+ "filename": "src/components/gitleaks.ts",
957
+ "line": 41
958
+ },
959
+ "name": "GitleaksOptions",
960
+ "properties": [
961
+ {
962
+ "abstract": true,
963
+ "docs": {
964
+ "default": "[]",
965
+ "stability": "stable",
966
+ "summary": "Path-scoped allowlists for known false positives, appended after `[extend] useDefault = true`."
967
+ },
968
+ "immutable": true,
969
+ "locationInModule": {
970
+ "filename": "src/components/gitleaks.ts",
971
+ "line": 54
972
+ },
973
+ "name": "allowlists",
974
+ "optional": true,
975
+ "type": {
976
+ "collection": {
977
+ "elementtype": {
978
+ "fqn": "@taimos/projen.GitleaksAllowlist"
979
+ },
980
+ "kind": "array"
981
+ }
982
+ }
983
+ },
984
+ {
985
+ "abstract": true,
986
+ "docs": {
987
+ "default": "'8.30.1'",
988
+ "stability": "stable",
989
+ "summary": "The gitleaks version downloaded in CI."
990
+ },
991
+ "immutable": true,
992
+ "locationInModule": {
993
+ "filename": "src/components/gitleaks.ts",
994
+ "line": 47
995
+ },
996
+ "name": "version",
997
+ "optional": true,
998
+ "type": {
999
+ "primitive": "string"
1000
+ }
1001
+ }
1002
+ ],
1003
+ "symbolId": "src/components/gitleaks:GitleaksOptions"
1004
+ },
756
1005
  "@taimos/projen.MonorepoAmplifyApp": {
757
1006
  "assembly": "@taimos/projen",
758
1007
  "datatype": true,
@@ -1046,7 +1295,7 @@
1046
1295
  },
1047
1296
  "locationInModule": {
1048
1297
  "filename": "src/projects/monorepo.ts",
1049
- "line": 317
1298
+ "line": 335
1050
1299
  },
1051
1300
  "parameters": [
1052
1301
  {
@@ -1060,7 +1309,7 @@
1060
1309
  "kind": "class",
1061
1310
  "locationInModule": {
1062
1311
  "filename": "src/projects/monorepo.ts",
1063
- "line": 282
1312
+ "line": 297
1064
1313
  },
1065
1314
  "name": "MonorepoProject",
1066
1315
  "properties": [
@@ -1074,7 +1323,7 @@
1074
1323
  "immutable": true,
1075
1324
  "locationInModule": {
1076
1325
  "filename": "src/projects/monorepo.ts",
1077
- "line": 289
1326
+ "line": 304
1078
1327
  },
1079
1328
  "name": "DEFAULT_RELEASE_AGE_EXCLUDE",
1080
1329
  "static": true,
@@ -1095,7 +1344,7 @@
1095
1344
  "immutable": true,
1096
1345
  "locationInModule": {
1097
1346
  "filename": "src/projects/monorepo.ts",
1098
- "line": 315
1347
+ "line": 333
1099
1348
  },
1100
1349
  "name": "defaultReleaseBranch",
1101
1350
  "type": {
@@ -1110,7 +1359,7 @@
1110
1359
  "immutable": true,
1111
1360
  "locationInModule": {
1112
1361
  "filename": "src/projects/monorepo.ts",
1113
- "line": 300
1362
+ "line": 315
1114
1363
  },
1115
1364
  "name": "prBuildWorkflow",
1116
1365
  "type": {
@@ -1125,7 +1374,7 @@
1125
1374
  "immutable": true,
1126
1375
  "locationInModule": {
1127
1376
  "filename": "src/projects/monorepo.ts",
1128
- "line": 297
1377
+ "line": 312
1129
1378
  },
1130
1379
  "name": "workspaceFile",
1131
1380
  "type": {
@@ -1140,7 +1389,7 @@
1140
1389
  "immutable": true,
1141
1390
  "locationInModule": {
1142
1391
  "filename": "src/projects/monorepo.ts",
1143
- "line": 312
1392
+ "line": 327
1144
1393
  },
1145
1394
  "name": "amplifyDeploy",
1146
1395
  "optional": true,
@@ -1156,7 +1405,7 @@
1156
1405
  "immutable": true,
1157
1406
  "locationInModule": {
1158
1407
  "filename": "src/projects/monorepo.ts",
1159
- "line": 303
1408
+ "line": 318
1160
1409
  },
1161
1410
  "name": "amplifyFile",
1162
1411
  "optional": true,
@@ -1172,7 +1421,7 @@
1172
1421
  "immutable": true,
1173
1422
  "locationInModule": {
1174
1423
  "filename": "src/projects/monorepo.ts",
1175
- "line": 306
1424
+ "line": 321
1176
1425
  },
1177
1426
  "name": "assignApprover",
1178
1427
  "optional": true,
@@ -1180,6 +1429,22 @@
1180
1429
  "fqn": "projen-pipelines.GitHubAssignApprover"
1181
1430
  }
1182
1431
  },
1432
+ {
1433
+ "docs": {
1434
+ "stability": "stable",
1435
+ "summary": "The gitleaks secret-scanning component, if enabled."
1436
+ },
1437
+ "immutable": true,
1438
+ "locationInModule": {
1439
+ "filename": "src/projects/monorepo.ts",
1440
+ "line": 330
1441
+ },
1442
+ "name": "gitleaks",
1443
+ "optional": true,
1444
+ "type": {
1445
+ "fqn": "@taimos/projen.Gitleaks"
1446
+ }
1447
+ },
1183
1448
  {
1184
1449
  "docs": {
1185
1450
  "stability": "stable",
@@ -1188,7 +1453,7 @@
1188
1453
  "immutable": true,
1189
1454
  "locationInModule": {
1190
1455
  "filename": "src/projects/monorepo.ts",
1191
- "line": 309
1456
+ "line": 324
1192
1457
  },
1193
1458
  "name": "productionRelease",
1194
1459
  "optional": true,
@@ -1251,7 +1516,7 @@
1251
1516
  "immutable": true,
1252
1517
  "locationInModule": {
1253
1518
  "filename": "src/projects/monorepo.ts",
1254
- "line": 266
1519
+ "line": 281
1255
1520
  },
1256
1521
  "name": "amplifyDeployOptions",
1257
1522
  "optional": true,
@@ -1343,6 +1608,43 @@
1343
1608
  }
1344
1609
  }
1345
1610
  },
1611
+ {
1612
+ "abstract": true,
1613
+ "docs": {
1614
+ "default": "false",
1615
+ "stability": "stable",
1616
+ "summary": "Whether to add gitleaks secret-scanning: a `.gitleaks.toml` config plus a pull-request workflow that scans the full git history (see `Gitleaks`)."
1617
+ },
1618
+ "immutable": true,
1619
+ "locationInModule": {
1620
+ "filename": "src/projects/monorepo.ts",
1621
+ "line": 261
1622
+ },
1623
+ "name": "gitleaks",
1624
+ "optional": true,
1625
+ "type": {
1626
+ "primitive": "boolean"
1627
+ }
1628
+ },
1629
+ {
1630
+ "abstract": true,
1631
+ "docs": {
1632
+ "default": "- extend the default ruleset, no extra allowlists",
1633
+ "remarks": "Only used when `gitleaks` is enabled.",
1634
+ "stability": "stable",
1635
+ "summary": "Options for the gitleaks component."
1636
+ },
1637
+ "immutable": true,
1638
+ "locationInModule": {
1639
+ "filename": "src/projects/monorepo.ts",
1640
+ "line": 268
1641
+ },
1642
+ "name": "gitleaksOptions",
1643
+ "optional": true,
1644
+ "type": {
1645
+ "fqn": "@taimos/projen.GitleaksOptions"
1646
+ }
1647
+ },
1346
1648
  {
1347
1649
  "abstract": true,
1348
1650
  "docs": {
@@ -2177,6 +2479,6 @@
2177
2479
  "symbolId": "src/projects/ts-lib:TaimosTypescriptLibraryOptions"
2178
2480
  }
2179
2481
  },
2180
- "version": "0.1.84",
2181
- "fingerprint": "IHUmLsSutyJApGXBQN3P70m0oh6BeoGLegfJcSxp1Hw="
2482
+ "version": "0.1.86",
2483
+ "fingerprint": "QaH2t/5432nWjNrfp7Qa0p345OOKDiThDhc4BxiDF+8="
2182
2484
  }