javascript/NativeScript
1
0
Fork 0
mirror of https://github.com/NativeScript/NativeScript.git synced 2025-11-05 13:26:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: implement basic public api

Browse Source
This commit is contained in:
Igor Randjelovic
2020-11-18 14:10:44 +01:00
parent 478a83d363
commit c1d240d66f
18 changed files with 201 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/webpack5/src/configuration/angular.ts
View File

@@ -2,9 +2,8 @@ import base from './base';
import { IWebpackEnv } from '@nativescript/webpack';
import Config from 'webpack-chain';
// todo: add base configuration for angular
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
return config;
}

20
packages/webpack5/src/configuration/base.ts
View File

@@ -1,13 +1,11 @@
import Config from 'webpack-chain';
import { IWebpackEnv, WebpackPlatform } from './index';
import { IWebpackEnv, Platform } from '../index';
import { CleanWebpackPlugin } from 'clean-webpack-plugin';
import { getDistPath } from '../helpers/projectHelpers';
import { DefinePlugin } from 'webpack';
import { WatchStateLoggerPlugin } from '../plugins/WatchStateLoggerPlugin';
// todo: add base configuration that's shared across all flavors
export default function (env: IWebpackEnv): Config {
const config = new Config();
export default function (config: Config, env: IWebpackEnv): Config {
const distPath = getDistPath(env);
const platform = determinePlatformFromEnv(env);
const mode = env.production ? 'production' : 'development';
@@ -21,7 +19,7 @@ export default function (env: IWebpackEnv): Config {
// look for loaders in
// - @nativescript/webpack/loaders
// - node_modules
config.resolveLoader.modules.add('@nativescript/webpack/loaders').add('node_modules');
config.resolveLoader.modules.add('@nativescript/webpack/dist/loaders').add('node_modules');
// inspector_modules
config.when(shouldIncludeInspectorModules(env), (config) => {
@@ -95,8 +93,8 @@ export default function (env: IWebpackEnv): Config {
config.plugin('DefinePlugin').use(DefinePlugin, [
{
'global.NS_WEBPACK': true,
'global.isAndroid': platform === WebpackPlatform.android,
'global.isIOS': platform === WebpackPlatform.ios,
'global.isAndroid': platform === 'android',
'global.isIOS': platform === 'ios',
process: 'global.process',
},
]);
@@ -120,16 +118,16 @@ function shouldIncludeInspectorModules(env: IWebpackEnv): boolean {
const platform = determinePlatformFromEnv(env);
// todo: check if core modules are external
// todo: check if we are testing
return platform === WebpackPlatform.ios;
return platform === 'ios';
}
function determinePlatformFromEnv(env: IWebpackEnv): WebpackPlatform {
function determinePlatformFromEnv(env: IWebpackEnv): Platform {
if (env?.android) {
return WebpackPlatform.android;
return 'android';
}
if (env?.ios) {
return WebpackPlatform.ios;
return 'ios';
}
throw new Error('You need to provide a target platform!');

42
packages/webpack5/src/configuration/index.ts
View File

@@ -7,36 +7,12 @@ import svelte from './svelte';
import typescript from './typescript';
import vue from './vue';
// export chain configs
// todo: rename if needed
export { base as __base, angular as __angular, javascript as __javascript, react as __react, svelte as __svelte, typescript as __typescript, vue as __vue };
// export final configs
export const baseConfig = (env: IWebpackEnv) => base(env).toConfig();
export const angularConfig = (env: IWebpackEnv) => angular(env).toConfig();
export const javascriptConfig = (env: IWebpackEnv) => javascript(env).toConfig();
export const reactConfig = (env: IWebpackEnv) => react(env).toConfig();
export const svelteConfig = (env: IWebpackEnv) => svelte(env).toConfig();
export const typescriptConfig = (env: IWebpackEnv) => typescript(env).toConfig();
export const vueConfig = (env: IWebpackEnv) => vue(env).toConfig();
export interface IWebpackEnv {
[name: string]: any;
appPath?: string;
appResourcesPath?: string;
android?: boolean;
ios?: boolean;
production?: boolean;
report?: boolean;
hmr?: boolean;
// todo: add others
}
export enum WebpackPlatform {
'ios',
'android',
}
export const configs = {
base,
angular,
javascript,
react,
svelte,
typescript,
vue,
};

4
packages/webpack5/src/configuration/javascript.ts
View File

@@ -3,8 +3,8 @@ import { IWebpackEnv } from '@nativescript/webpack';
import Config from 'webpack-chain';
// todo: add base configuration for core with javascript
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
// set up xml
config.module

5
packages/webpack5/src/configuration/react.ts
View File

@@ -3,9 +3,8 @@ import { IWebpackEnv } from '@nativescript/webpack';
import Config from 'webpack-chain';
import { merge } from 'webpack-merge';
// todo: add base configuration for react
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
// todo: use env
let isAnySourceMapEnabled = true;

4
packages/webpack5/src/configuration/svelte.ts
View File

@@ -3,8 +3,8 @@ import { IWebpackEnv } from '@nativescript/webpack';
import Config from 'webpack-chain';
// todo: add base configuration for svelte
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
return config;
}

4
packages/webpack5/src/configuration/typescript.ts
View File

@@ -3,8 +3,8 @@ import { IWebpackEnv } from '@nativescript/webpack';
import Config from 'webpack-chain';
// todo: add base configuration for core
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
return config;
}

8
packages/webpack5/src/configuration/vue.ts
View File

@@ -1,11 +1,11 @@
import base from './base';
import Config from 'webpack-chain';
import { VueLoaderPlugin } from 'vue-loader';
import { IWebpackEnv } from './index';
import { IWebpackEnv } from '../index';
import { merge } from 'webpack-merge';
// todo: add base configuration for vue
export default function (env: IWebpackEnv): Config {
const config = base(env);
export default function (config: Config, env: IWebpackEnv): Config {
base(config, env);
// resolve .vue files
config.resolve.extensions.prepend('.vue');

53
packages/webpack5/src/helpers/temp.ts Normal file
View File

@@ -0,0 +1,53 @@
import { existsSync } from 'fs';
import { getPackageJson } from './projectHelpers';
import { resolve } from 'path';
// todo: get rid of these or reduce them to their simplest form
// no need to do magical string replacements, loops etc...
/**
* Function to ensure the app directory exists
*
* @param appDirectory
*/
function verifyEntryModuleDirectory(appDirectory: string) {
if (!appDirectory) {
throw new Error('Path to app directory is not specified. Unable to find entry module.');
}
if (!existsSync(appDirectory)) {
throw new Error(`The specified path to app directory ${appDirectory} does not exist. Unable to find entry module.`);
}
}
function getPackageJsonEntry(appDirectory) {
const packageJsonSource = getPackageJson(appDirectory);
const entry = packageJsonSource.main;
if (!entry) {
throw new Error(`${appDirectory}/package.json must contain a 'main' attribute!`);
}
return entry.replace(/\.js$/i, '');
}
export function getEntryModule(appDirectory: string, platform: 'android' | 'ios') {
verifyEntryModuleDirectory(appDirectory);
const entry = getPackageJsonEntry(appDirectory);
const tsEntryPath = resolve(appDirectory, `${entry}.ts`);
const jsEntryPath = resolve(appDirectory, `${entry}.js`);
let entryExists = existsSync(tsEntryPath) || existsSync(jsEntryPath);
if (!entryExists && platform) {
const platformTsEntryPath = resolve(appDirectory, `${entry}.${platform}.ts`);
const platformJsEntryPath = resolve(appDirectory, `${entry}.${platform}.js`);
entryExists = existsSync(platformTsEntryPath) || existsSync(platformJsEntryPath);
}
if (!entryExists) {
throw new Error(`The entry module ${entry} specified in ` + `${appDirectory}/package.json doesn't exist!`);
}
return entry;
}

93
packages/webpack5/src/index.ts
View File

@@ -1,55 +1,66 @@
export * from './configuration';
import { existsSync } from "fs";
import { getPackageJson } from './helpers/projectHelpers';
import { resolve } from "path";
import Config from 'webpack-chain';
import webpack, { config } from 'webpack';
import { configs } from './configuration';
export type Platform = 'android' | 'ios' | string;
export type Platform = 'android' | 'ios';
/**
* Function to ensure the app directory exists
*
* @param appDirectory
*/
function verifyEntryModuleDirectory(appDirectory: string) {
if (!appDirectory) {
throw new Error("Path to app directory is not specified. Unable to find entry module.");
}
export interface IWebpackEnv {
[name: string]: any;
if (!existsSync(appDirectory)) {
throw new Error(`The specified path to app directory ${appDirectory} does not exist. Unable to find entry module.`);
}
appPath?: string;
appResourcesPath?: string;
android?: boolean;
ios?: boolean;
production?: boolean;
report?: boolean;
hmr?: boolean;
// todo: add others
}
function getPackageJsonEntry(appDirectory) {
const packageJsonSource = getPackageJson(appDirectory);
const entry = packageJsonSource.main;
let webpackChains: any[] = [];
let webpackMerges: any[] = [];
let env: IWebpackEnv = {};
if (!entry) {
throw new Error(`${appDirectory}/package.json must contain a 'main' attribute!`);
}
////// PUBLIC API
export const defaultConfigs = configs;
return entry.replace(/\.js$/i, "");
export function init(_env: IWebpackEnv) {
if (_env) {
env = _env;
}
// todo: determine default config based on deps and print **useful** error if it fails.
}
export function useConfig(config: 'angular' | 'javascript' | 'react' | 'svelte' | 'typescript' | 'vue') {
webpackChains.push(configs[config]);
}
export function getEntryModule (appDirectory: string, platform: 'android' | 'ios') {
verifyEntryModuleDirectory(appDirectory);
export function chainWebpack(chainFn: (config: Config, env: IWebpackEnv) => any) {
webpackChains.push(chainFn);
}
const entry = getPackageJsonEntry(appDirectory);
export function mergeWebpack(mergeFn: (config: Partial<webpack.Configuration>, env: IWebpackEnv) => any | Partial<webpack.Configuration>) {
webpackMerges.push(mergeFn);
}
const tsEntryPath = resolve(appDirectory, `${entry}.ts`);
const jsEntryPath = resolve(appDirectory, `${entry}.js`);
let entryExists = existsSync(tsEntryPath) || existsSync(jsEntryPath);
if (!entryExists && platform) {
const platformTsEntryPath = resolve(appDirectory, `${entry}.${platform}.ts`);
const platformJsEntryPath = resolve(appDirectory, `${entry}.${platform}.js`);
entryExists = existsSync(platformTsEntryPath) || existsSync(platformJsEntryPath);
}
export function resolveChainableConfig() {
const config = new Config();
if (!entryExists) {
throw new Error(`The entry module ${entry} specified in ` +
`${appDirectory}/package.json doesn't exist!`)
}
// this applies all chain configs
webpackChains.forEach((chainFn) => {
return chainFn(config, env);
});
return entry;
};
return config;
}
export function resolveConfig(chainableConfig = resolveChainableConfig()) {
// todo: warn if no base config
// todo: apply merges from webpackMerges
// return a config usable by webpack
return chainableConfig.toConfig();
}

11
packages/webpack5/src/stubs/default.config.stub.js Normal file
View File

@@ -0,0 +1,11 @@
const webpack = require("@nativescript/webpack");
module.exports = (env) => {
webpack.init(env);
// todo: comments for common usage
return webpack.resolveConfig();
};