Merge pull request #29 from sinProject-Inc/25-variable-and-function-names-to-snake_case

close #25

Author: sinproject-iwasaki

.eslintrc.cjs

@@ -6,15 +6,85 @@ module.exports = {
 	ignorePatterns: ['*.cjs'],
 	overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
 	settings: {
-		'svelte3/typescript': () => require('typescript')
+		'svelte3/typescript': () => require('typescript'),
 	},
 	parserOptions: {
 		sourceType: 'module',
-		ecmaVersion: 2020
+		ecmaVersion: 2020,
 	},
 	env: {
 		browser: true,
 		es2017: true,
-		node: true
-	}
-};
+		node: true,
+	},
+	rules: {
+		'@typescript-eslint/explicit-member-accessibility': ['error'],
+		'@typescript-eslint/explicit-function-return-type': ['warn'],
+		'@typescript-eslint/naming-convention': [
+			'error',
+			{
+				selector: 'typeParameter',
+				format: ['UPPER_CASE'],
+			},
+			{
+				selector: ['class', 'interface', 'typeAlias'],
+				format: ['PascalCase'],
+			},
+			{
+				selector: ['method', 'function'],
+				modifiers: ['private'],
+				format: ['snake_case'],
+				leadingUnderscore: 'require',
+			},
+			{
+				selector: ['method', 'function'],
+				modifiers: ['protected'],
+				format: ['snake_case'],
+				leadingUnderscore: 'require',
+			},
+			{
+				selector: ['method', 'function'],
+				format: ['snake_case'],
+			},
+			{
+				selector: [
+					'property',
+					'accessor',
+					'parameter',
+					'parameterProperty',
+					'variable',
+					'enumMember',
+				],
+				modifiers: ['private'],
+				format: ['snake_case'],
+				leadingUnderscore: 'require',
+			},
+			{
+				selector: [
+					'property',
+					'accessor',
+					'parameter',
+					'parameterProperty',
+					'variable',
+					'enumMember',
+				],
+				modifiers: ['protected'],
+				format: ['snake_case'],
+				leadingUnderscore: 'require',
+			},
+			{
+				selector: ['accessor', 'parameter', 'parameterProperty', 'enumMember'],
+				format: ['snake_case'],
+			},
+			{
+				selector: ['variable'],
+				format: ['snake_case', 'UPPER_CASE', 'camelCase'],
+			},
+			// {
+			// 	selector: ['property'],
+			// 	format: ['snake_case', 'UPPER_CASE', 'camelCase'],
+			// },
+			// TODO: 引数、関数、クラス、インターフェイス、enumのメンバー名のルール
+		],
+	},
+}

src/hooks.server.ts

@@ -9,10 +9,10 @@ export const handle: Handle = async ({ event, resolve }) => {
 	const session_id = cookiesManager.session_id
 	if (!session_id) return await resolve(event)
 
-	const auth_token = await Auth.findAuthToken(session_id)
+	const auth_token = await Auth.find_auth_token(session_id)
 	if (!auth_token) return await resolve(event)
 
-	await Auth.accessValid(auth_token.id, event.cookies)
+	await Auth.access_valid(auth_token.id, event.cookies)
 
 	event.locals.user = {
 		twitter_id: auth_token.user.twitter_id,

src/lib/auth.ts

@@ -4,11 +4,11 @@ import { CookiesManager } from "./cookies_manager"
 import { Database, db } from "./database"
 
 export class Auth {
-	public static async getSessionLifetimeSec(): Promise<number> {
-		return await Database.getAppSettingInt('session_lifetime_sec')
+	public static async get_session_lifetime_sec(): Promise<number> {
+		return await Database.get_app_setting_int('session_lifetime_sec')
 	}
 
-	public static getLimit(lifetime_sec: number): Date {
+	public static get_limit(lifetime_sec: number): Date {
 		const limit = new Date()
 
 		if (lifetime_sec == 0) console.warn('lifetime_sec is 0')
@@ -18,11 +18,11 @@ export class Auth {
 		return limit
 	}
 
-	public static async createAuthToken(
+	public static async create_auth_token(
 		user_id: number,
 		session_lifetime_sec: number
 	): Promise<AuthToken> {
-		const session_limit = await Auth.getLimit(session_lifetime_sec)
+		const session_limit = await Auth.get_limit(session_lifetime_sec)
 
 		const [auth_token] = await db.$transaction([
 			db.authToken.create({
@@ -36,30 +36,30 @@ export class Auth {
 		return auth_token
 	}
 
-	public static async signIn(user_id: number, cookies: Cookies): Promise<void> {
-		const session_lifetime_sec = await Auth.getSessionLifetimeSec()
-		const auth_token = await Auth.createAuthToken(user_id, session_lifetime_sec)
+	public static async sign_in(user_id: number, cookies: Cookies): Promise<void> {
+		const session_lifetime_sec = await Auth.get_session_lifetime_sec()
+		const auth_token = await Auth.create_auth_token(user_id, session_lifetime_sec)
 
-		new CookiesManager(cookies).setSessionId(auth_token.token)
+		new CookiesManager(cookies).set_session_id(auth_token.token)
 	}
 
-	public static async signOut(cookies: Cookies): Promise<void> {
+	public static async sign_out(cookies: Cookies): Promise<void> {
 		const cookiesManager = new CookiesManager(cookies)
 
 		await db.authToken.delete({ where: { token: cookiesManager.session_id } })
-		cookiesManager.deleteSessionId()
+		cookiesManager.delete_session_id()
 	}
 
-	public static async findAuthToken(session_id: string): Promise<
+	public static async find_auth_token(session_id: string): Promise<
 		| (AuthToken & {
 				user: User & {
 					role: Role
 				}
 		  })
 		| null
 	> {
-		const session_lifetime_sec = await Auth.getSessionLifetimeSec()
-		const session_limit = Auth.getLimit(session_lifetime_sec)
+		const session_lifetime_sec = await Auth.get_session_lifetime_sec()
+		const session_limit = Auth.get_limit(session_lifetime_sec)
 
 		const auth_token = await db.authToken.findFirst({
 			where: {
@@ -78,7 +78,7 @@ export class Auth {
 		return auth_token
 	}
 
-	public static async updateAuthToken(auth_token_id: number): Promise<AuthToken> {
+	public static async update_auth_token(auth_token_id: number): Promise<AuthToken> {
 		const auth_token = await db.authToken.update({
 			where: { id: auth_token_id },
 			data: { updated_at: new Date() },
@@ -87,12 +87,12 @@ export class Auth {
 		return auth_token
 	}
 
-	public static async accessValid(auth_token_id: number, cookies?: Cookies): Promise<void> {
-		const auth_token = await Auth.updateAuthToken(auth_token_id)
-		const session_lifetime_sec = await Auth.getSessionLifetimeSec()
+	public static async access_valid(auth_token_id: number, cookies?: Cookies): Promise<void> {
+		const auth_token = await Auth.update_auth_token(auth_token_id)
+		const session_lifetime_sec = await Auth.get_session_lifetime_sec()
 
 		if (cookies) {
-			new CookiesManager(cookies).setSessionId(auth_token.token, session_lifetime_sec)
+			new CookiesManager(cookies).set_session_id(auth_token.token, session_lifetime_sec)
 		}
 	}
 }

src/lib/cookies_manager.ts

@@ -9,7 +9,7 @@ export class CookiesManager {
 		return this._cookies.get(CookiesManager._session_id_key) ?? ''
 	}
 
-	public setSessionId(session_id: string, max_age_sec?: number): void {
+	public set_session_id(session_id: string, max_age_sec?: number): void {
 		this._cookies.set(CookiesManager._session_id_key, session_id, {
 			path: '/',
 			maxAge: max_age_sec,
@@ -20,7 +20,7 @@ export class CookiesManager {
 		})
 	}
 
-	public deleteSessionId(): void {
+	public delete_session_id(): void {
 		this._cookies.delete(CookiesManager._session_id_key)
 	}
 }

src/lib/database.ts

@@ -8,15 +8,15 @@ enum Roles {
 export const db = new prisma.PrismaClient()
 
 export class Database {
-	public static async upsertUser(twitter_id: string, access_token: string): Promise<User | undefined> {
+	public static async upsert_user(twitter_id: string, access_token: string): Promise<User | undefined> {
 		return await db.user.upsert({
 			where: { twitter_id },
 			update: { access_token },
 			create: { twitter_id, access_token, role: { connect: { name: Roles.user } } },
 		})
 	}
 
-	public static async getAppSettingInt(key: string): Promise<number> {
+	public static async get_app_setting_int(key: string): Promise<number> {
 		const appSetting = await db.appSetting.findUnique({ where: { key } })
 		const number_value = Number(appSetting?.value)
 		const number_value_not_nan = Number.isNaN(number_value) ? 0 : number_value

src/routes/+page.svelte

@@ -3,7 +3,7 @@
 
 	console.log($page.data.user)
 
-	function signInWithTwitter(): void {
+	function sign_in_with_twitter(): void {
 		const form_element = document.getElementById('sign_in')
 
 		if (form_element instanceof HTMLFormElement) {
@@ -18,7 +18,7 @@
 </p>
 
 <form method="POST" action="/sign_in" id="sign_in">
-	<div class="sign_in" on:click={signInWithTwitter} on:keypress={signInWithTwitter}>
+	<div class="sign_in" on:click={sign_in_with_twitter} on:keypress={sign_in_with_twitter}>
 		<div class="flex_row_twitter">
 			<img src="./twitter_social_icon_circle_blue.svg" alt="" width="20px" />
 			<div>Sign in with Twitter</div>

src/routes/home/+page.svelte

@@ -46,20 +46,20 @@
 
 	// console.log(timeline)
 
-	function toLocalDate(date?: string): string {
+	function to_local_date(date?: string): string {
 		if (!date) return ''
 
 		return new Date(date).toLocaleString('ja-JP')
 	}
 
-	function isRetweet(tweet: components['schemas']['Tweet']): boolean {
+	function is_retweet(tweet: components['schemas']['Tweet']): boolean {
 		return (
 			tweet.referenced_tweets?.some((referenced_tweet) => referenced_tweet.type === 'retweeted') ??
 			false
 		)
 	}
 
-	function getTargetTweet(tweet: components['schemas']['Tweet']): components['schemas']['Tweet'] {
+	function get_target_tweet(tweet: components['schemas']['Tweet']): components['schemas']['Tweet'] {
 		if (tweet.referenced_tweets) {
 			const referenced_tweet = tweet.referenced_tweets[0]
 
@@ -72,17 +72,17 @@
 		return tweet
 	}
 
-	function getUser(
+	function get_user(
 		tweet: components['schemas']['Tweet'],
-		isOriginal = false
+		is_original = false
 	): components['schemas']['User'] | undefined {
-		const target_tweet = isOriginal ? tweet : getTargetTweet(tweet)
+		const target_tweet = is_original ? tweet : get_target_tweet(tweet)
 
 		return user_map.get(target_tweet.author_id ?? '')
 	}
 
-	function getText(tweet: components['schemas']['Tweet']): string {
-		const target_tweet = getTargetTweet(tweet)
+	function get_text(tweet: components['schemas']['Tweet']): string {
+		const target_tweet = get_target_tweet(tweet)
 
 		return target_tweet.text ?? ''
 	}
@@ -104,21 +104,21 @@
 
 {#each tweets as tweet}
 	<div class="element">
-		{#if isRetweet(tweet)}
+		{#if is_retweet(tweet)}
 			<div class="retweet_row">
 				<div class="avatar_above"><div class="retweet"><Retweet /></div></div>
-				{getUser(tweet, true)?.name}さんがリツイートしました
+				{get_user(tweet, true)?.name}さんがリツイートしました
 			</div>
 		{/if}
 		<div class="tweet">
-			<img class="avatar" src={getUser(tweet)?.profile_image_url} alt="avatar" />
+			<img class="avatar" src={get_user(tweet)?.profile_image_url} alt="avatar" />
 			<div class="text_column">
 				<div class="username_row">
-					<div class="name overflow_ellipsis">{getUser(tweet)?.name}</div>
-					<div class="username overflow_ellipsis">@{getUser(tweet)?.username}</div>
-					<div class="time">{toLocalDate(tweet.created_at)}</div>
+					<div class="name overflow_ellipsis">{get_user(tweet)?.name}</div>
+					<div class="username overflow_ellipsis">@{get_user(tweet)?.username}</div>
+					<div class="time">{to_local_date(tweet.created_at)}</div>
 				</div>
-				{getText(tweet)}
+				{get_text(tweet)}
 			</div>
 		</div>
 	</div>

src/routes/sign_in/+server.ts

@@ -53,11 +53,11 @@ export const GET: RequestHandler = async ({ cookies, url }) => {
 
 		// console.log(email)
 
-		const user = await Database.upsertUser(twitter_id, access_token)
+		const user = await Database.upsert_user(twitter_id, access_token)
 
 		if (!user) return new Response('No user', { status: 500 })
 
-		await Auth.signIn(user.id, cookies)
+		await Auth.sign_in(user.id, cookies)
 
 		throw redirect(302, '/')
 	} catch (error) {

src/routes/sign_out/+page.server.ts

@@ -3,13 +3,13 @@ import { redirect, type Actions } from '@sveltejs/kit'
 import type { PageServerLoad } from './$types'
 
 export const load: PageServerLoad = async ({cookies}) => {
-	await Auth.signOut(cookies)
+	await Auth.sign_out(cookies)
 	throw redirect(302, '/')
 }
 
 export const actions: Actions = {
 	default: async ({ cookies }) => {
-		await Auth.signOut(cookies)
+		await Auth.sign_out(cookies)
 		throw redirect(302, '/')
 	},
 }