[Sleact] 슬랙 클론 코딩 - 프로젝트 세팅

인프런 조현영님의 슬랙 클론 코딩 강의입니다.

프로젝트 세팅

요즘 프론트엔드 개발은 세팅이 절반인 것 같다. 그만큼 세팅해야할 것도 많고 들어가는 시간도 길다. 이런 시간을 단축하기 위해서 CRA 를 사용할 수 있지만 프로젝트의 규모가 커지고 복잡해진다면 결국 그 세팅 과정을 알아야하고 커스텀해야한다.

npm init

npm init 을 통해 package.json 파일을 생성할 수 있다.
package.json

{
  "name": "sleact",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "dev": "cross-env TS_NODE_PROJECT=\"tsconfig-for-webpack-config.json\" webpack serve --env development",
    "build": "cross-env NODE_ENV=production TS_NODE_PROJECT=\"tsconfig-for-webpack-config.json\" webpack",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Shin Wonse",
  "license": "MIT",
  "dependencies": {
    ...
  },
  "devDependencies": {
    ...
  },
  "description": ""
}

package.json은 프로젝트 정보와 의존성(dependencies)을 관리하는 문서이며, 이미 작성된 package.json 문서는 어느 곳에서도 동일한 개발 환경을 구축할 수 있게 해준다. name 정도 옵션만 초기 설정에서 중요하다.

tsconfig.json

tsconfig.json

{
  "compilerOptions": {
    // import * as React from 'react' 대신 
    // import React from 'react' 로 쓸 수 있다.
    "esModuleInterop": true, 
    "sourceMap": true, // 에러난 위치를 찾기 편하다.
    "lib": ["ES2020", "DOM"], // ES 최신문법과 DOM
    "jsx": "react", // jsx가 react 말고도 다른 프로그래밍에서 쓰이는 것을 방지
    "module": "esnext", // 최신 모듈을 사용하겠다 (import, export).
    "moduleResolution": "Node",
    "target": "es5",
    "strict": true, // 엄격한 타입 적용
    "resolveJsonModule": true,
    "baseUrl": ".",
    "paths": { // import A from ../../../../hello.js 대신
      "@hooks/*": ["hooks/*"],
      "@components/*": ["components/*"],
      "@layouts/*": ["layouts/*"],
      "@pages/*": ["pages/*"],
      "@utils/*": ["utils/*"],
      "@typings/*": ["typings/*"]
    }
  }
}

TypeScript 를 사용하기 때문에 tsconfig.json 파일이 필수적이다. 여기서 내가 처음 본 옵션은 "paths" 옵션인데 지저분해보이는 import 과정을 보기 좋게 변환할 수 있다. 이 옵션은 실제로 내 졸업프로젝트 리팩토링 과정에 적용할 예정이다.

prettier와 eslint

.eslintrc

{
  "extends": ["plugin:prettier/recommended", "react-app"]
}

'prettier 가 추천하는대로 따르겠다' 라는 뜻이다.

.prettierrc

{
  "printWidth": 120,
  "tabWidth": 2,
  "singleQuote": true,
  "trailingComma": "all",
  "semi": true
}

커스텀할 수 있는 게 그렇게 많지는않다.

webpack

webpack.config.ts

import path from 'path';
import ReactRefreshWebpackPlugin from '@pmmmwh/react-refresh-webpack-plugin';
import webpack from 'webpack';
import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';

const isDevelopment = process.env.NODE_ENV !== 'production';

const config: webpack.Configuration = {
  name: 'sleact',
  mode: isDevelopment ? 'development' : 'production',
  devtool: !isDevelopment ? 'hidden-source-map' : 'eval',
  resolve: {
    extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
    alias: {
      '@hooks': path.resolve(__dirname, 'hooks'),
      '@components': path.resolve(__dirname, 'components'),
      '@layouts': path.resolve(__dirname, 'layouts'),
      '@pages': path.resolve(__dirname, 'pages'),
      '@utils': path.resolve(__dirname, 'utils'),
      '@typings': path.resolve(__dirname, 'typings'),
    },
  },
  entry: {
    app: './client',
  },
  module: {
    rules: [
      {
        test: /\.tsx?$/,
        loader: 'babel-loader',
        options: {
          presets: [
            [
              '@babel/preset-env',
              {
                targets: { browsers: ['last 2 chrome versions'] },
                debug: isDevelopment,
              },
            ],
            '@babel/preset-react',
            '@babel/preset-typescript',
          ],
          env: {
            development: {
              plugins: [['@emotion', { sourceMap: true }], require.resolve('react-refresh/babel')],
            },
            production: {
              plugins: ['@emotion'],
            },
          },
        },
        exclude: path.join(__dirname, 'node_modules'),
      },
      {
        test: /\.css?$/,
        use: ['style-loader', 'css-loader'],
      },
    ],
  },
  plugins: [
    new ForkTsCheckerWebpackPlugin({
      async: false,
      // eslint: {
      //   files: "./src/**/*",
      // },
    }),
    new webpack.EnvironmentPlugin({ NODE_ENV: isDevelopment ? 'development' : 'production' }),
  ],
  output: {
    path: path.join(__dirname, 'dist'),
    filename: '[name].js',
    publicPath: '/dist/',
  },
  devServer: {
    historyApiFallback: true, // react router
    port: 3090,
    publicPath: '/dist/',
    proxy: {
      '/api/': {
        target: 'http://localhost:3095',
        changeOrigin: true,
      },
    },
  },
};

if (isDevelopment && config.plugins) {
  config.plugins.push(new webpack.HotModuleReplacementPlugin());
  config.plugins.push(new ReactRefreshWebpackPlugin());
  config.plugins.push(new BundleAnalyzerPlugin({ analyzerMode: 'server', openAnalyzer: true }));
}
if (!isDevelopment && config.plugins) {
  config.plugins.push(new webpack.LoaderOptionsPlugin({ minimize: true }));
  config.plugins.push(new BundleAnalyzerPlugin({ analyzerMode: 'static' }));
}

export default config;

프로젝트 구조

위와 같은 프로젝트 구조를 가지고있다.

index.html

<html>
  <head>
    <meta charset="UTF-8" />
    <meta
      name="viewport"
      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
    />
    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
    <title>슬리액</title>
    <style>
      html,
      body {
        margin: 0;
        padding: 0;
        overflow: initial !important;
      }
      body {
        font-size: 15px;
        line-height: 1.46668;
        font-weight: 400;
        font-variant-ligatures: common-ligatures;
        -moz-osx-font-smoothing: grayscale;
        -webkit-font-smoothing: antialiased;
      }
      * {
        box-sizing: border-box;
      }
    </style>
    <link
      rel="stylesheet"
      href="https://a.slack-edge.com/bv1-9/client-boot-styles.dc0a11f.css?cacheKey=gantry-1613184053"
      crossorigin="anonymous"
    />
    <link rel="shortcut icon" href="https://a.slack-edge.com/cebaa/img/ico/favicon.ico" />
    <link
      href="https://a.slack-edge.com/bv1-9/slack-icons-v2-16ca3a7.woff2"
      rel="preload"
      as="font"
      crossorigin="anonymous"
    />
  </head>
  <body>
    <div id="app"></div>
    <script src="/dist/app.js"></script>
  </body>
</html>

html 이 간과되고 있는 경우가 많은데 사실 엄청나게 중요한 파일이다. SEO 에 있어서도 중요하고, 구글에서는 해당 파일에 공통 css를 작성할 것을 권장하고 있다. 이 파일 실행 이후에 비로소 JavaScript 파일을 실행하기 때문에 성능에 있어서 차이가 있다.

client.tsx

import React from 'react';
import { render } from 'react-dom';
import App from '@layouts/App';
import { BrowserRouter } from 'react-router-dom';

render(
  <BrowserRouter>
    <App />
  </BrowserRouter>,
  document.querySelector('#app'),
);

// pages - 서비스 페이지
// components - 짜잘 컴포넌트
// layouts - 공통 레이아웃

서비스의 시작점이 되는 파일이다.

layouts/App.tsx

import React from 'react';
import loadable from '@loadable/component';
import { Switch, Route, Redirect } from 'react-router';

const LogIn = loadable(() => import('@pages/LogIn'));
const SignUp = loadable(() => import('@pages/SignUp'));

const App = () => {
  return (
    <Switch>
      <Redirect exact path="/" to="/login" />
      <Route path="/login" component={LogIn} />
      <Route path="/signup" component={SignUp} />
    </Switch>
  );
};

export default App;

loadable 라이브러리를 통해 코드 스플리팅을 하였다. 초기 페이지는 로그인 페이지로 설정하였고, 회원가입 이외에 어떤 url을 입력하여도 로그인 페이지로 리다이렉트되게 하였다.