@whittakertech/virgil 0.1.0

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.
Files changed (77) hide show
  1. package/.tool-versions +1 -0
  2. package/README.md +230 -0
  3. package/dist/cli.d.ts +3 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +39 -0
  6. package/dist/cli.js.map +1 -0
  7. package/dist/engine/hash.d.ts +20 -0
  8. package/dist/engine/hash.d.ts.map +1 -0
  9. package/dist/engine/hash.js +53 -0
  10. package/dist/engine/hash.js.map +1 -0
  11. package/dist/engine/lock.d.ts +18 -0
  12. package/dist/engine/lock.d.ts.map +1 -0
  13. package/dist/engine/lock.js +54 -0
  14. package/dist/engine/lock.js.map +1 -0
  15. package/dist/engine/manifest.d.ts +14 -0
  16. package/dist/engine/manifest.d.ts.map +1 -0
  17. package/dist/engine/manifest.js +39 -0
  18. package/dist/engine/manifest.js.map +1 -0
  19. package/dist/engine/run.d.ts +15 -0
  20. package/dist/engine/run.d.ts.map +1 -0
  21. package/dist/engine/run.js +110 -0
  22. package/dist/engine/run.js.map +1 -0
  23. package/dist/generators/og-image.d.ts +16 -0
  24. package/dist/generators/og-image.d.ts.map +1 -0
  25. package/dist/generators/og-image.js +46 -0
  26. package/dist/generators/og-image.js.map +1 -0
  27. package/dist/generators/robots.d.ts +9 -0
  28. package/dist/generators/robots.d.ts.map +1 -0
  29. package/dist/generators/robots.js +29 -0
  30. package/dist/generators/robots.js.map +1 -0
  31. package/dist/generators/sitemap.d.ts +9 -0
  32. package/dist/generators/sitemap.d.ts.map +1 -0
  33. package/dist/generators/sitemap.js +24 -0
  34. package/dist/generators/sitemap.js.map +1 -0
  35. package/dist/index.d.ts +8 -0
  36. package/dist/index.d.ts.map +1 -0
  37. package/dist/index.js +5 -0
  38. package/dist/index.js.map +1 -0
  39. package/dist/templates/og-default.html +100 -0
  40. package/dist/types/lock.d.ts +11 -0
  41. package/dist/types/lock.d.ts.map +1 -0
  42. package/dist/types/lock.js +2 -0
  43. package/dist/types/lock.js.map +1 -0
  44. package/dist/types/manifest.d.ts +7 -0
  45. package/dist/types/manifest.d.ts.map +1 -0
  46. package/dist/types/manifest.js +2 -0
  47. package/dist/types/manifest.js.map +1 -0
  48. package/dist/types/spec.d.ts +47 -0
  49. package/dist/types/spec.d.ts.map +1 -0
  50. package/dist/types/spec.js +2 -0
  51. package/dist/types/spec.js.map +1 -0
  52. package/dist/utils/fs.d.ts +13 -0
  53. package/dist/utils/fs.d.ts.map +1 -0
  54. package/dist/utils/fs.js +32 -0
  55. package/dist/utils/fs.js.map +1 -0
  56. package/dist/utils/paths.d.ts +14 -0
  57. package/dist/utils/paths.d.ts.map +1 -0
  58. package/dist/utils/paths.js +30 -0
  59. package/dist/utils/paths.js.map +1 -0
  60. package/package.json +37 -0
  61. package/src/cli.ts +47 -0
  62. package/src/engine/hash.ts +71 -0
  63. package/src/engine/lock.ts +72 -0
  64. package/src/engine/manifest.ts +52 -0
  65. package/src/engine/run.ts +156 -0
  66. package/src/generators/og-image.ts +65 -0
  67. package/src/generators/robots.ts +44 -0
  68. package/src/generators/sitemap.ts +36 -0
  69. package/src/index.ts +8 -0
  70. package/src/templates/og-default.html +100 -0
  71. package/src/types/lock.ts +11 -0
  72. package/src/types/manifest.ts +6 -0
  73. package/src/types/spec.ts +52 -0
  74. package/src/utils/fs.ts +32 -0
  75. package/src/utils/paths.ts +33 -0
  76. package/tsconfig.json +20 -0
  77. package/virgil.spec.example.json +65 -0
package/virgil.spec.example.json ADDED
@@ -0,0 +1,65 @@
1
+ {
2
+ "brand": {
3
+ "name": "WhittakerTech",
4
+ "logo": "docs/public/logo.svg",
5
+ "color": "#5b7cff"
6
+ },
7
+ "product": {
8
+ "name": "MosaicJS",
9
+ "logo": "docs/public/mosaic-logo.svg",
10
+ "version": "0.3.0"
11
+ },
12
+ "outputs": [
13
+ {
14
+ "type": "og-image",
15
+ "id": "getting-started",
16
+ "page": {
17
+ "title": "Getting Started",
18
+ "url": "https://mosaicjs.whittakertech.com/getting-started",
19
+ "description": "Learn how to integrate MosaicJS into your project"
20
+ }
21
+ },
22
+ {
23
+ "type": "og-image",
24
+ "id": "api-reference",
25
+ "page": {
26
+ "title": "API Reference",
27
+ "url": "https://mosaicjs.whittakertech.com/api",
28
+ "description": "Complete API documentation for MosaicJS"
29
+ }
30
+ },
31
+ {
32
+ "type": "sitemap",
33
+ "id": "main",
34
+ "baseUrl": "https://mosaicjs.whittakertech.com",
35
+ "pages": [
36
+ {
37
+ "path": "/",
38
+ "changefreq": "weekly",
39
+ "priority": 1.0
40
+ },
41
+ {
42
+ "path": "/getting-started",
43
+ "changefreq": "monthly",
44
+ "priority": 0.9
45
+ },
46
+ {
47
+ "path": "/api",
48
+ "changefreq": "weekly",
49
+ "priority": 0.8
50
+ }
51
+ ]
52
+ },
53
+ {
54
+ "type": "robots",
55
+ "id": "default",
56
+ "rules": [
57
+ {
58
+ "userAgent": "*",
59
+ "allow": ["/"]
60
+ }
61
+ ],
62
+ "sitemap": "https://mosaicjs.whittakertech.com/sitemap.xml"
63
+ }
64
+ ]
65
+ }