YAML Spec

FNS spec - ver1.0_draft

Definition

This describes the structure and composition that file and folder names should have. This specification is saved as a YAML format file.

Detailed specifications

It must include at least 4 parts without omission and in order, using ”---”.

---

### part1: Description of the document

TITLE: yaml example # This is the title of the document. Required field
FNS_VERSION: 1.0 # Version of the FNS spec. Required field
date: 2020-01-01 # The remaining items can be freely added to describe this file. Key names must use lowercase.

---

### part2: Name and path patterns

- folder name: # Ending with ":" indicates it's a folder.
  - subfolder name:   # Tree structure is represented by spaces at the front
  - <pattern1>-<color>  # Patterns are expressed using < and >

### part3: Actual examples that can come for patterns defined in part1. Not mandatory

color:["black","red","white"]  # Stored as an array.

### part4: Describes patterns defined in part1 that can be expressed as regular expressions.

pattern1:'.+'

Custom pattern names must use lowercase. Uppercase patterns may be included in the specification. (YYYY, MM, etc.)

Actual example

---

TITLE: yaml example
FNS_VERSION: 1.0
date: 2020-01-01

---

- Reports:
    - <YYYY>: # Year 2020 2021 2022 ...
        - <MM>: # Month 01 02 03 ...
            - <YYYYMMDD>-<TITLE>.xlsx # 20200101-Marketing Report.xlsx
- <INDEX01>-<routine_work>: # 02-Customer Management 03-Monitoring ...
- projects:
    - <project>: # Project Name
        - <task>:
            - <TITLE>-<task>-<project>-<YYYYMMDD>-v<ver>.<EXT> # Moon Landing Project Proposal-Planning-Moon Landing-20200101-v1.0.ppt

---

# The second area: lists examples of patterns that can be used.

task: ["Research", "Planning", "Development", "Release", "Marketing"]
project: ["MoonLanding", "MoonShot", "MoonWalking"]
EXT: ["pdf", "xlsx", "ppt"]

---

# In the third area : patterns that can be recognized by computers are described using regular expressions.

YYYYMMDD: '(?:19|20)\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\d|3[01])' # Date (Year-Month-Day)
YYYY: '(?:19|20)\d{2}' # Year 2019 2020 2021 ...
MM: "0[1-9]|1[0-2]" # Month 01 02 .. 12
INDEX01: "0[1-9]|[1-9][0-9]" # Number 01 02 03 ...
INDEX001: "0[0-9]{2}|[1-9][0-9]{2}" # Number 001 002 003 ...
ver: '(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?' # Version 1.0.0 Reference: https://github.com/nils-tekampe/semverdoc/blob/master/semverdoc.md
EXT: "[a-zA-Z0-9]{1,5}" # File extension pdf xlsx ppt ...

저장위치

FNS 파일은 기준폴더를 기준으로 ./.fns/index.yaml 에 저장합니다. 예) documents/.fns/index.yaml , videos/.fns/index.yaml

FNS 파일 유효성 체크

YAML Spec을 따라야 합니다.
아래와 같은 4개의 Document를 포함해야 합니다.
1. 첫번째 document : 문서에 대한 설명
  - “TITLE” 과 “FNS_VERSION” 키값을 가진 Mapping 이어야 함. (값은 문자열 Scalar)
2. 두번째 document : 파일명 및 경로명 패턴
  - 최상위 항목은 Block Sequence이어야 합니다.
  - Block Sequence는 Mapping (하위 폴더를 의미) 또는 문자열 Scalar (파일을 의미)를 가질 수 있습니다.
  - Mapping은 반드시 단 하나의 key 를 가져야 하며, 이 키값에 하위폴더의 이름이 저장됩니다.
  - Mapping의 value 값은 반드시 Block Sequence (하위폴더에 목록이 있는 경우) 또는 빈값(빈폴더인 경우)이어야 합니다.
3. 세번째 document : 패턴의 예들
  - 여러개의 Mapping이 존재할수 있고, key값(패턴이름) 과 value값을 가집니다. 이 value값에는 문자열(패턴에 올 수 있는 문자열 예들) Scalar 배열이 저장됩니다.
4. 네번째 document : 패턴을 위한 정규식
  - 여러개의 Mapping이 존재할수 있고, key값(패턴이름) 과 value값을 가집니다. 이 value값에는 문자열(패턴에 인식할 수 있는 정규식) 문자열 Scalar가 저장됩니다.

참여하기

의견이나 질문이 있으면 discussions에 참여할 수 있습니다.