feat: add frameworks titles

README.md

@@ -26,6 +26,7 @@ console.log(await listFrameworks({ projectDir: './path/to/gatsby/website' }))
 // [
 //   {
 //     name: 'gatsby',
+//     title: 'Gatsby',
 //     category: 'static_site_generator',
 //     dev: {
 //       commands: ['gatsby develop'],
@@ -44,6 +45,7 @@ console.log(await listFrameworks({ projectDir: './path/to/vue/website' }))
 // [
 //   {
 //     name: 'vue',
+//     title: 'Vue.js',
 //     category: 'frontend_framework',
 //     dev: {
 //       commands: ['npm run serve'],
@@ -64,6 +66,7 @@ console.log(await hasFramework('vue', { projectDir: './path/to/vue/website' }))
 console.log(await getFramework('vue', { projectDir: './path/to/vue/website' }))
 // {
 //   name: 'vue',
+//   title: 'Vue.js',
 //   category: 'frontend_framework',
 //   dev: {
 //     commands: ['npm run serve'],
@@ -88,6 +91,7 @@ $ framework-info --long ./path/to/vue/website
 [
   {
     "name": "vue",
+    "title": 'Vue.js',
     "category": "frontend_framework",
     "dev": {
       "commands": ["npm run serve"],
@@ -138,6 +142,12 @@ _Type_: `string`
 
 Name such as `"gatsby"`.
 
+## title
+
+_Type_: `string`
+
+Title such as `"Gatsby"`.
+
 #### category
 
 _Type_: `string`
@@ -228,6 +238,7 @@ Each framework is a JSON file in the `/src/frameworks/` directory. For example:
 ```json
 {
   "name": "gatsby",
+  "title": "Gatsby",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["gatsby"],
@@ -255,6 +266,12 @@ _Type_: `string`
 
 Name of the framework, lowercase.
 
+## title
+
+_Type_: `string`
+
+Title of the framework.
+
 ## category
 
 _Type_: `string`

src/core.js

@@ -42,7 +42,8 @@ const getContext = (context) => {
 
 /**
  * @typedef {object} Framework
- * @property {string} name - Name such as `"gatsby"`
+ * @property {string} name - framework name such as `"gatsby"`
+ * @property {string} title - framework title as `"Gatsby"`
  * @property {string} category - Category among `"static_site_generator"`, `"frontend_framework"` and `"build_tool"`
  * @property {Dev} dev - Information about the dev command
  * @property {Build} build - Information about the build command
@@ -131,6 +132,7 @@ const getProjectInfo = async function ({ pathExists, packageJson, packageJsonPat
 const getFrameworkInfo = function (
   {
     name,
+    title,
     category,
     dev: { command: frameworkDevCommand, port },
     build: { command: frameworkBuildCommand, directory },
@@ -143,6 +145,7 @@ const getFrameworkInfo = function (
   const recommendedPlugins = getPlugins(plugins, { nodeVersion })
   return {
     name,
+    title,
     category,
     dev: { commands: devCommands, port },
     build: { commands: [frameworkBuildCommand], directory },

src/frameworks/angular.json

@@ -1,5 +1,6 @@
 {
   "name": "angular",
+  "title": "Angular",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["@angular/cli"],

src/frameworks/assemble.json

@@ -1,5 +1,6 @@
 {
   "name": "assemble",
+  "title": "Assemble",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["assemble"],

src/frameworks/brunch.json

@@ -1,5 +1,6 @@
 {
   "name": "brunch",
+  "title": "Brunch",
   "category": "build_tool",
   "detect": {
     "npmDependencies": ["brunch"],

src/frameworks/create-react-app.json

@@ -1,5 +1,6 @@
 {
   "name": "create-react-app",
+  "title": "Create React App",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["react-scripts"],

src/frameworks/docpad.json

@@ -1,5 +1,6 @@
 {
   "name": "docpad",
+  "title": "DocPad",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["docpad"],

src/frameworks/docusaurus-v2.json

@@ -1,5 +1,6 @@
 {
   "name": "docusaurus-v2",
+  "title": "Docusaurus 2",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["@docusaurus/core"],

src/frameworks/docusaurus.json

@@ -1,5 +1,6 @@
 {
   "name": "docusaurus",
+  "title": "Docusaurus",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["docusaurus"],

src/frameworks/eleventy.json

@@ -1,5 +1,6 @@
 {
   "name": "eleventy",
+  "title": "Eleventy",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["@11ty/eleventy"],

src/frameworks/ember.json

@@ -1,5 +1,6 @@
 {
   "name": "ember",
+  "title": "Ember.js",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["ember-cli"],

src/frameworks/expo.json

@@ -1,5 +1,6 @@
 {
   "name": "expo",
+  "title": "Expo",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["expo"],

src/frameworks/gatsby.json

@@ -1,5 +1,6 @@
 {
   "name": "gatsby",
+  "title": "Gatsby",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["gatsby"],

src/frameworks/gridsome.json

@@ -1,5 +1,6 @@
 {
   "name": "gridsome",
+  "title": "Gridsome",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["gridsome"],

src/frameworks/grunt.json

@@ -1,5 +1,6 @@
 {
   "name": "grunt",
+  "title": "Grunt",
   "category": "build_tool",
   "detect": {
     "npmDependencies": ["grunt"],

src/frameworks/gulp.json

@@ -1,5 +1,6 @@
 {
   "name": "gulp",
+  "title": "gulp.js",
   "category": "build_tool",
   "detect": {
     "npmDependencies": ["gulp"],

src/frameworks/harp.json

@@ -1,5 +1,6 @@
 {
   "name": "harp",
+  "title": "Harp",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["harp"],

src/frameworks/hexo.json

@@ -1,5 +1,6 @@
 {
   "name": "hexo",
+  "title": "Hexo",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["hexo"],

src/frameworks/hugo.json

@@ -1,5 +1,6 @@
 {
   "name": "hugo",
+  "title": "Hugo",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": [],

src/frameworks/jekyll.json

@@ -1,5 +1,6 @@
 {
   "name": "jekyll",
+  "title": "Jekyll",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": [],

src/frameworks/metalsmith.json

@@ -1,5 +1,6 @@
 {
   "name": "metalsmith",
+  "title": "Metalsmith",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["metalsmith"],

src/frameworks/middleman.json

@@ -1,5 +1,6 @@
 {
   "name": "middleman",
+  "title": "Middleman",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": [],

src/frameworks/next.json

@@ -1,5 +1,6 @@
 {
   "name": "next",
+  "title": "Next.js",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["next"],

src/frameworks/nuxt.json

@@ -1,5 +1,6 @@
 {
   "name": "nuxt",
+  "title": "Next.js",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["nuxt"],

src/frameworks/parcel.json

@@ -1,5 +1,6 @@
 {
   "name": "parcel",
+  "title": "Parcel",
   "category": "build_tool",
   "detect": {
     "npmDependencies": ["parcel-bundler", "parcel"],

src/frameworks/phenomic.json

@@ -1,5 +1,6 @@
 {
   "name": "phenomic",
+  "title": "Phenomic",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["@phenomic/core"],

src/frameworks/quasar-v0.17.json

@@ -1,5 +1,6 @@
 {
   "name": "quasar-v0.17",
+  "title": "Quasar",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["quasar-cli"],

src/frameworks/quasar.json

@@ -1,5 +1,6 @@
 {
   "name": "quasar",
+  "title": "Quasar",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["@quasar/app"],

src/frameworks/react-static.json

@@ -1,5 +1,6 @@
 {
   "name": "react-static",
+  "title": "React Static",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["react-static"],

src/frameworks/roots.json

@@ -1,5 +1,6 @@
 {
   "name": "roots",
+  "title": "Roots",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["roots"],

src/frameworks/sapper.json

@@ -1,5 +1,6 @@
 {
   "name": "sapper",
+  "title": "Sapper",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["sapper"],

src/frameworks/stencil.json

@@ -1,5 +1,6 @@
 {
   "name": "stencil",
+  "title": "Stencil",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["@stencil/core"],

src/frameworks/svelte.json

@@ -1,5 +1,6 @@
 {
   "name": "svelte",
+  "title": "Svelte",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["svelte"],

src/frameworks/vue.json

@@ -1,5 +1,6 @@
 {
   "name": "vue",
+  "title": "Vue.js",
   "category": "frontend_framework",
   "detect": {
     "npmDependencies": ["@vue/cli-service"],

src/frameworks/vuepress.json

@@ -1,5 +1,6 @@
 {
   "name": "vuepress",
+  "title": "VuePress",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["vuepress"],

src/frameworks/wintersmith.json

@@ -1,5 +1,6 @@
 {
   "name": "wintersmith",
+  "title": "Wintersmith",
   "category": "static_site_generator",
   "detect": {
     "npmDependencies": ["wintersmith"],

test/frameworks.js

@@ -47,10 +47,11 @@ const PLUGIN_SCHEMA = {
 const MAX_PORT = 65535
 const FRAMEWORK_JSON_SCHEMA = {
   type: 'object',
-  required: ['name', 'category', 'detect', 'dev', 'build', 'env'],
+  required: ['name', 'title', 'category', 'detect', 'dev', 'build', 'env'],
   additionalProperties: false,
   properties: {
     name: { type: 'string', pattern: '^[a-z\\d_]+', minLength: 1 },
+    title: { type: 'string', pattern: '^\\w+', minLength: 1 },
     category: {
       type: 'string',
       enum: ['static_site_generator', 'frontend_framework', 'build_tool'],

test/snapshots/bin.js.md

@@ -25,6 +25,7 @@ Generated by [AVA](https://ava.li).
     `[␊
       {␊
         "name": "vuepress",␊
+        "title": "VuePress",␊
         "category": "static_site_generator",␊
         "dev": {␊
           "commands": [␊
@@ -43,6 +44,7 @@ Generated by [AVA](https://ava.li).
       },␊
       {␊
         "name": "vue",␊
+        "title": "Vue.js",␊
         "category": "frontend_framework",␊
         "dev": {␊
           "commands": [␊
@@ -75,6 +77,7 @@ Generated by [AVA](https://ava.li).
     `[␊
       {␊
         "name": "next",␊
+        "title": "Next.js",␊
         "category": "static_site_generator",␊
         "dev": {␊
           "commands": [␊
@@ -102,6 +105,7 @@ Generated by [AVA](https://ava.li).
     `[␊
       {␊
         "name": "next",␊
+        "title": "Next.js",␊
         "category": "static_site_generator",␊
         "dev": {␊
           "commands": [␊

test/snapshots/main.js.md

@@ -25,6 +25,7 @@ Generated by [AVA](https://ava.li).
       env: {},
       name: 'sapper',
       plugins: [],
+      title: 'Sapper',
     }
 
 ## Should detect frameworks
@@ -49,5 +50,6 @@ Generated by [AVA](https://ava.li).
         env: {},
         name: 'sapper',
         plugins: [],
+        title: 'Sapper',
       },
     ]