Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): add priority to framework detection #4617

Merged
merged 2 commits into from
May 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cli/src/definitions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,12 @@ export interface FrameworkConfig {
name: string;
isMatch: (config: Config) => boolean;
webDir: string;
/**
* Specific UI libraries (Ionic) and higher-level frameworks (NextJs/Gatsby)
* should be prioritorized over a more generic framework like React/Angular/Vue.
* Lower the priorty number the more important it is (1 has more priority over 2).
* This helps to make sure a specific framework like "NextJs" is chosen before
* the more generic "React".
*/
priority: number;
}
33 changes: 23 additions & 10 deletions cli/src/framework-configs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,75 +3,88 @@ import type { Config, FrameworkConfig } from './definitions';
const FRAMEWORK_CONFIGS: FrameworkConfig[] = [
{
name: 'Angular',
isMatch: config =>
hasDependency(config, '@angular/cli') &&
!hasDependency(config, '@ionic/angular'),
isMatch: config => hasDependency(config, '@angular/cli'),
webDir: 'dist',
priority: 3,
},
{
name: 'Create React App',
isMatch: config =>
hasDependency(config, 'react-scripts') &&
!hasDependency(config, '@ionic/react'),
isMatch: config => hasDependency(config, 'react-scripts'),
webDir: 'build',
priority: 3,
},
{
name: 'Ember',
isMatch: config => hasDependency(config, 'ember-cli'),
webDir: 'dist',
priority: 3,
},
{
name: 'Gatsby',
isMatch: config => hasDependency(config, 'gatsby'),
webDir: 'public',
priority: 2,
},
{
name: 'Ionic Angular',
isMatch: config => hasDependency(config, '@ionic/angular'),
webDir: 'www',
priority: 1,
},
{
name: 'Ionic React',
isMatch: config => hasDependency(config, '@ionic/react'),
webDir: 'build',
priority: 1,
},
{
name: 'Ionic Vue',
isMatch: config => hasDependency(config, '@ionic/vue'),
webDir: 'public',
priority: 1,
},
{
name: 'Next',
isMatch: config => hasDependency(config, 'next'),
webDir: 'public',
priority: 2,
},
{
name: 'Preact',
isMatch: config => hasDependency(config, 'preact-cli'),
webDir: 'build',
priority: 3,
},
{
name: 'Stencil',
isMatch: config => hasDependency(config, '@stencil/core'),
webDir: 'www',
priority: 3,
},
{
name: 'Svelte',
isMatch: config =>
hasDependency(config, 'svelte') && hasDependency(config, 'sirv-cli'),
webDir: 'public',
priority: 3,
},
{
name: 'Vue',
isMatch: config =>
hasDependency(config, '@vue/cli-service') &&
!hasDependency(config, '@ionic/vue'),
isMatch: config => hasDependency(config, '@vue/cli-service'),
webDir: 'dist',
priority: 3,
},
];

export function detectFramework(config: Config): FrameworkConfig | undefined {
return FRAMEWORK_CONFIGS.find(f => f.isMatch(config));
const frameworks = FRAMEWORK_CONFIGS.filter(f => f.isMatch(config)).sort(
(a, b) => {
if (a.priority < b.priority) return -1;
if (a.priority > b.priority) return 1;
return 0;
},
);
return frameworks[0];
}

function hasDependency(config: Config, depName: string): boolean {
Expand Down
5 changes: 4 additions & 1 deletion cli/test/framework-detection.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ describe('framework detection', () => {
expect(f?.webDir).toBe('dist');
});

it.only('Create React App', () => {
it('Create React App', () => {
addDep(config, 'react-scripts');
const f = detectFramework(config);
expect(f?.name).toBe('Create React App');
Expand All @@ -53,6 +53,7 @@ describe('framework detection', () => {
});

it('Gatsby', () => {
addDep(config, 'react-scripts');
addDep(config, 'gatsby');
const f = detectFramework(config);
expect(f?.name).toBe('Gatsby');
Expand All @@ -76,6 +77,7 @@ describe('framework detection', () => {

it('Ionic React', () => {
addDep(config, '@ionic/react');
addDep(config, 'react-scripts');
const f = detectFramework(config);
expect(f?.name).toBe('Ionic React');
expect(f?.webDir).toBe('build');
Expand Down Expand Up @@ -107,6 +109,7 @@ describe('framework detection', () => {

it('Next', () => {
addDep(config, 'next');
addDep(config, 'react-scripts');
const f = detectFramework(config);
expect(f?.name).toBe('Next');
expect(f?.webDir).toBe('public');
Expand Down