Skip to content

Commit a5e0430

Browse files
somedeveloper00somedeveloper00
committed
added class accessibility level enum option
1 parent 6afcabd commit a5e0430

File tree

4 files changed

+38
-12
lines changed

4 files changed

+38
-12
lines changed

‎package.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,27 @@
8282
"markdownDescription": "Auto complete classes like `MonoBehaviour` and `Editor`.",
8383
"default": true
8484
},
85+
"unity-code-snippets.classAccessibilityLevel": {
86+
"type": "string",
87+
"markdownDescription": "Select the class accessibility levels.",
88+
"order": 105,
89+
"default": "public",
90+
"enum": [
91+
"public",
92+
"internal",
93+
"none"
94+
],
95+
"enumItemLabels": [
96+
"public",
97+
"internal",
98+
"empty (internal)"
99+
],
100+
"markdownEnumDescriptions": [
101+
"[Access is not restricted.](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/public)",
102+
"[Access is limited to the current assembly.](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/internal)",
103+
"Uses nothing which lets C# use the default [(internal)](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/class) option."
104+
]
105+
},
85106
"unity-code-snippets.autoComplete.methods": {
86107
"type": "boolean",
87108
"order": 110,

‎src/model.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ export const DEST_PATH = 'snippets/snippets.json';
44
export const ISSUES_URL = 'https://github.com/kleber-swf/vscode-unity-code-snippets/issues';
55

66
export type IndentationStyle = 'kr' | 'allman';
7+
export type ClassAccessibilityLevel = 'public' |'internal' | 'none';
78

8-
export type ReplaceType = 'PRIVATE' | 'LINE_BREAK' | 'TAB';
9+
export type ReplaceType = 'PRIVATE' | 'CLASS_ACCESSIBILITY_LEVEL' | 'LINE_BREAK' | 'TAB';
910
export type Replaces = Record<ReplaceType, string>;
1011

1112
export const TEMPLATES = ['classes', 'methods', 'calls', 'attributes', 'experimentalAttributes'] as const;

‎src/options.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as vscode from 'vscode';
2-
import { AutoCompletes, IndentationStyle, Options, Replaces, TEMPLATES } from './model';
2+
import { AutoCompletes, ClassAccessibilityLevel, IndentationStyle, Options, Replaces, TEMPLATES } from './model';
33

44
export function parseOptions(conf: vscode.WorkspaceConfiguration): Options {
55
return {
@@ -18,12 +18,16 @@ function parseAutoCompletes(conf: vscode.WorkspaceConfiguration): AutoCompletes
1818
function parseReplaces(conf: vscode.WorkspaceConfiguration): Replaces {
1919
const style = conf.get('style') as IndentationStyle;
2020
const usePrivateKeyword = conf.get('usePrivateKeyword') as boolean;
21+
const classAccessibilityLevelKeyword = conf.get('classAccessibilityLevel') as ClassAccessibilityLevel;
2122

2223
const replaces: Replaces = {} as any;
2324

2425
// private keyword
2526
replaces.PRIVATE = usePrivateKeyword ? 'private ' : '';
2627

28+
// class accessibility level
29+
replaces.CLASS_ACCESSIBILITY_LEVEL = classAccessibilityLevelKeyword === 'none' ? '' : `${classAccessibilityLevelKeyword} `;
30+
2731
// indentation style
2832
if (style === 'allman') {
2933
replaces.LINE_BREAK = '",\n\t\t\t"';

‎templates/classes.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"body": [
66
"using UnityEngine;",
77
"",
8-
"public class ${TM_FILENAME_BASE} : MonoBehaviour%LINE_BREAK%{",
8+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : MonoBehaviour%LINE_BREAK%{",
99
"\t$0",
1010
"}"
1111
]
@@ -17,7 +17,7 @@
1717
"body": [
1818
"using UnityEngine;",
1919
"",
20-
"public class ${TM_FILENAME_BASE} : StateMachineBehaviour%LINE_BREAK%{",
20+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : StateMachineBehaviour%LINE_BREAK%{",
2121
"\tpublic override void OnStateEnter(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)%LINE_BREAK%%TAB%{",
2222
"\t\t$0",
2323
"\t}",
@@ -32,7 +32,7 @@
3232
"using UnityEngine;",
3333
"using UnityEngine.Networking;",
3434
"",
35-
"public class ${TM_FILENAME_BASE} : NetworkBehaviour%LINE_BREAK%{",
35+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : NetworkBehaviour%LINE_BREAK%{",
3636
"\t$0",
3737
"}"
3838
]
@@ -45,7 +45,7 @@
4545
"using UnityEngine;",
4646
"",
4747
"[CreateAssetMenu(fileName = \"${1:${TM_FILENAME_BASE}}\", menuName = \"${2:${TM_FILENAME_BASE}}\", order = ${3:0})]",
48-
"public class ${TM_FILENAME_BASE} : ScriptableObject%LINE_BREAK%{",
48+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : ScriptableObject%LINE_BREAK%{",
4949
"\t$0",
5050
"}"
5151
]
@@ -59,7 +59,7 @@
5959
"using UnityEditor;",
6060
"",
6161
"[CustomEditor(typeof(${1:${TM_FILENAME_BASE/(.*)Editor/${1}/}}))]",
62-
"public class ${TM_FILENAME_BASE} : Editor%LINE_BREAK%{",
62+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : Editor%LINE_BREAK%{",
6363
"\tpublic override void OnInspectorGUI()%LINE_BREAK%%TAB%{",
6464
"\t\tbase.OnInspectorGUI();",
6565
"\t\t$0",
@@ -77,7 +77,7 @@
7777
"using UnityEditorInternal;",
7878
"",
7979
"[CustomEditor(typeof(${1:${TM_FILENAME_BASE/(.*)Editor/${1}/}}))]",
80-
"public class ${TM_FILENAME_BASE} : Editor%LINE_BREAK%{",
80+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : Editor%LINE_BREAK%{",
8181
"\t%PRIVATE%SerializedProperty _property;",
8282
"\t%PRIVATE%ReorderableList _list;",
8383
"",
@@ -115,7 +115,7 @@
115115
"using UnityEngine;",
116116
"using UnityEditor;",
117117
"",
118-
"public class ${TM_FILENAME_BASE} : EditorWindow%LINE_BREAK%{",
118+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE} : EditorWindow%LINE_BREAK%{",
119119
"\t[MenuItem(\"${1:${TM_FILEPATH/.*\\\\(.*)\\\\Assets\\\\.*/${1}/}/${TM_FILENAME_BASE/(.*)Editor/${1}/}}\")]",
120120
"\t%PRIVATE%static void ShowWindow()%LINE_BREAK%%TAB%{",
121121
"\t\tvar window = GetWindow<${TM_FILENAME_BASE}>();",
@@ -138,7 +138,7 @@
138138
"using UnityEditor;",
139139
"",
140140
"[CustomPropertyDrawer(typeof(${1:${TM_FILENAME_BASE/(.*)Drawer/${1}/}}))]",
141-
"public class ${TM_FILENAME_BASE}: PropertyDrawer%LINE_BREAK%{",
141+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE}: PropertyDrawer%LINE_BREAK%{",
142142
"\tpublic override void OnGUI(Rect position, SerializedProperty property, GUIContent label)%LINE_BREAK%%TAB%{",
143143
"\t\t$0",
144144
"\t}",
@@ -153,7 +153,7 @@
153153
"using UnityEngine;",
154154
"using UnityEditor;",
155155
"",
156-
"public class ${TM_FILENAME_BASE}: ScriptableWizard%LINE_BREAK%{",
156+
"%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE}: ScriptableWizard%LINE_BREAK%{",
157157
"\t[MenuItem(\"${1:${TM_FILEPATH/.*\\\\(.*)\\\\Assets\\\\.*/${1}/}/${TM_FILENAME_BASE/(.*)Wizard/${1}/}}\")]",
158158
"\t%PRIVATE%static void MenuEntryCall()%LINE_BREAK%%TAB%{",
159159
"\t\tDisplayWizard<${TM_FILENAME_BASE}>(\"${2:Title}\");",
@@ -169,7 +169,7 @@
169169
"General class": {
170170
"prefix": "class",
171171
"description": "Creates a standard class.",
172-
"body": ["public class ${TM_FILENAME_BASE}%LINE_BREAK%{", "\t$0", "}"]
172+
"body": ["%CLASS_ACCESSIBILITY_LEVEL%class ${TM_FILENAME_BASE}%LINE_BREAK%{", "\t$0", "}"]
173173
},
174174

175175
"General interface": {

0 commit comments

Comments
 (0)