YAML spec

Note

This document has been automatically translated. Request modification

FNS spec - v1.1

Definition

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

Storage location

FNS files are stored in ’./.fns/index.yaml’ based on the reference folder. Example: documents/.fns/index.yaml , videos/.fns/index.yaml

Detailed specifications

It must include at least 3 parts without omission, keeping the order, using ”---”.

---

### part1: description of the document

TITLE: yaml example # This is the title of the document. Required field
FNS_VERSION: 1.1 # Version of FNS spec. Required field
date: 2020-01-01 # You can freely add and use this to describe the yaml file. In this case, the key name should 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 >
    # Self-created pattern names should use lowercase. Uppercase is used for pattern names managed by the specification.
---

### part3: describes various properties for patterns defined in part2. (not required)

EX: # Actual examples that can come in the pattern
  - color: ["black","red","white"]  # Stored as an array.
REG: # Describes patterns that can be expressed as regular expressions.
  - pattern1: '.+'
schema: # You can freely add various properties. In this case, lowercase should be used.
  - color: https://schema.org/color

Real example

---

TITLE: yaml example
FNS_VERSION: 1.1
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

---

EX:
  task: ["Research", "Planning", "Development", "Release", "Marketing"]
  project: ["MoonLanding", "MoonShot", "MoonWalking"]
  EXT: ["pdf", "xlsx", "ppt"]
REG:
  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 ...

Caution

yaml interprets ‘no’ as false, not as a string. You should input - “no” instead of - no.

FNS file validity check

• Must follow the YAML Spec.
• Must include the following 4 documents:
  1. First document: description of the document
     • Must be a mapping with keys “TITLE” and “FNS_VERSION” (values are string scalars)
  2. Second document: filename and path patterns
     • The top-level item must be a block sequence.
     • The block sequence can contain mappings (representing subfolders) or string scalars (representing files).
     • Mappings must have only one key, which stores the name of the subfolder.
     • The value of a mapping must be either a block sequence (if the subfolder has contents) or empty (if it’s an empty folder).
  3. Third document: description of pattern attributes
     • The top-level item is a mapping with multiple keys (REG, EX, etc.)

How to participate

If you have any opinions or questions, you can participate in the discussions.

Previous versions

• ver1.0_draft